etagsdb.h

Go to the documentation of this file.

#ifndef ETAGS_H_INCLUDED
#define ETAGS_H_INCLUDED
//
// Copyright 2002, 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.
//
// Warning:  not all files in this directory structure are covered by the
// same copyright.  Some of them are part of the GNU source distribution
// and you must obey the GPL copyright for those files.


#include <string>
#include <portable_io.h>
#include <list>

namespace cxxtls
{

class EtagsDB
{
  FILE*       file_;      
  std::string filename_;  
  std::string symbol_;    

public:

 EtagsDB(std::string etags_database_filename); 
 EtagsDB();                                    

 ~EtagsDB();                                   

 bool ok() const { return file_ != 0; }

 bool set_tags_file(std::string tagsfile);  






 bool find_first(std::string const &symbol,
                 std::string       *file_name,
                 int               *line_number,
                 std::string       *line_text,    // text of line of definition
                 bool              case_sensitive_search=false
                );


 bool find_next( std::string       *file_name,
                 int               *line_number,
                 std::string       *line_text
                );


 int matching_files(std::string relative_path, std::list<std::string> *output) const;

                
private:

  bool case_sensitive_;

  EtagsDB(EtagsDB const &);               

  EtagsDB& operator= (EtagsDB const&);    

  char most_recent_file_[2048];           


  int  searchFor(  std::string const &symbol,
                   std::string       *foundFile,
                   int               *foundLine,
                   std::string       *sourceText
                );

};

} // namespace cxxtls

#endif