code_dox.h

// -*-c++-*-
#ifndef STORMM_SEARCH_DOX_H
#define STORMM_SEARCH_DOX_H
 
#include <vector>
#include <string>
#include "copyright.h"
 
namespace stormm {
namespace docs {
 
using parse::TextFileReader;

class ObjectIdentifier {
public:

  ObjectIdentifier(const std::string &filename_in);

  ~ObjectIdentifier() = default;

  int getInstanceCount() const;

  const std::string getFileName() const;

  int getReturnTypeCount() const;

  const std::string getReturnType(const int nt = 0) const;

  void addInstance(const int n_add = 1);

  void addReturnType(const std::string rtype);
 
private:
  const std::string file_name;           
  std::vector<std::string> return_types; 
  int n_instances;                       
};

enum class ObjectReportType {
  FULL,             
  ANNOTATION_ONLY,  
  STATS_ONLY        
};

enum class PreProcessorScopeModifier {
  NONE,  
  IF,    
  ELIF,  
  ELSE,  
  ENDIF, 
};

struct CppScope {
  int start_line;                      
  int start_pos;                       
  int end_line;                        
  int end_pos;                         
  std::string scope_name;              
  std::string file_name;               
  std::vector<std::string> namespaces; 

  CppScope(const std::string &filename_in);

  ~CppScope() = default;
};

bool lineIsPreProcessor(const char* line, int nchar);

PreProcessorScopeModifier testScopeModifier(const char* line, int nchar);

std::vector<int3> findPreProcessorScopes(const TextFileReader &tfr);

std::vector<CppScope> findCppScopes(const TextFileReader &tfr);

ObjectIdentifier searchFileForObject(const std::string &object_name, const std::string &filename);

void searchObject(const std::string &object_name,  const std::string &member_name = std::string(),
                  ObjectReportType report_format = ObjectReportType::FULL);
 
} // namespace docs
} // namespace stormm
 
 
#endif