cpptagdb.h

Go to the documentation of this file.

#ifndef CPPTAGDB_HEADER_FILE_INCLUDED_P
#define CPPTAGDB_HEADER_FILE_INCLUDED_P
//
// Copyright 2011, Lowell Boggs Jr.
//
// This file or directory, containing source code for a computer program,
// is Copyrighted by Lowell Boggs, Jr.  987 Regency Drive, Lewisville
// TX (USA), 75067.  You may use, copy, modify, and distribute this
// source file without charge or obligation so long as you agree to
// the following:
//
//  1.  You must indemnify Lowell Boggs against any and all financial
//      obligations caused by its use, misuse, function, or malfunction.
//      Further, you acknowledge that there is no warranty of any kind,
//      whatsoever.
//
//  2.  You agree not to attempt to patent any portion of this original
//      work -- though you may attempt to patent your own extensions to
//      it if you so choose.
//
//  3.  You keep this copyright notice with the file and all copies
//      of the file and do not change it anyway except language translation.
//
// You are responsible for enforcing your own compliance with these
// conditions and may not use this source file if you cannot agree to the
// above terms and conditions.


#include <vector>
#include <map>
#include <set>
#include <iostream>

#include <string>

namespace cxxtls
{
namespace CppTagDB
{

    struct SymbolInfo
    {
       enum Type
       {
           Function,
           Variable,
           Class,       // or struct or union
           Enum,        // name of an enumeration type
           Enumeration, // enumeration value
           Typedef,
           Namespace,
           FileScope,    // a file containing scopes
           Used,         // using symbol;
           Define,       // #define name
           unknownType,
       };

       std::string fullname_;   
       std::string member_;     
       std::string type_;       
       std::string file_;       
       int         line_;       
       Type        typeId_;     

       SymbolInfo()
       : line_(0)
       {
       }

       SymbolInfo(std::string const &symbol, 
                  std::string const &member, 
                  std::string const &type,
                  std::string const &file,
                  int                line
                 )
       : fullname_(symbol)
       , member_(member)
       , type_(type)
       , file_(file)
       , line_(line)
       , typeId_(computeTypeId(type))
       {
       }

       typedef std::multimap<std::string, SymbolInfo> Children; // keyed on member name

       Children children_;  


       typedef Children::iterator iterator;             // just for convenience
       typedef Children::const_iterator const_iterator; // just for convenience

       void output(std::ostream &s, std::string indent) const;

       friend std::ostream &operator<< (std::ostream &s, SymbolInfo const &me)
       {
          me.output(s, "");
          return s;
       }


       Type computeTypeId(std::string const &typeName);

       char typeChar() const;  

       std::string annotatedName(bool member=false) const; 


    };

class Info
{
public:
    typedef std::multimap<std::string, std::string> FilesMap;  




    typedef std::multimap<std::string, SymbolInfo const *> MembersMap;  




    typedef std::set<std::string> Directories; 



    SymbolInfo symbols_;  



    FilesMap files_;  


    Directories directories_; 

    MembersMap members_; 

    void findMatchingFiles(std::string const &fileNodeName, std::vector<std::string> &output) const;

    void findMatchingMembers(std::string const &memberName, std::vector<SymbolInfo const *> &output, bool caseSensitive=true) const;

    void findRelativeFiles(std::string const &relativeSubPath, std::vector<std::string> &output) const;



    Info() 
    {
    }

    int populate(std::string const &filename, int &failedLine);


    int populate(FILE *f, int &failedLine); 






    friend std::ostream &operator<< (std::ostream &s, Info const &me); 



private:

    int populateSymbol(std::string const &filename, std::string const &info); 





};

} // namespace CppTagDB
} // namespace cxxtls



#endif