Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00056 #ifndef __FUNC2DOCBUDDY_H___
00057 #define __FUNC2DOCBUDDY_H___
00058
00059 #include <boost/filesystem/path.hpp>
00060 #include <map>
00061 #include <vector>
00062
00063 #include <openfluid/dllexport.hpp>
00064 #include <openfluid/buddies/OFBuddy.hpp>
00065
00066
00067 namespace openfluid { namespace buddies {
00068
00069 class BuddiesListener;
00070
00071
00072 class DLLEXPORT Func2DocBuddy : public OpenFLUIDBuddy
00073 {
00074 private:
00075 typedef std::map< std::string,std::vector<std::string> > SignatureData_t;
00076
00077 std::string m_CPPFile;
00078 std::string m_LatexOutFile;
00079
00080 boost::filesystem::path m_InputDirPath;
00081 boost::filesystem::path m_OutputDirPath;
00082 boost::filesystem::path m_InputFilePath;
00083 boost::filesystem::path m_OutputLatexFilePath;
00084 boost::filesystem::path m_TplFilePath;
00085 boost::filesystem::path m_CProcessedFilePath;
00086 boost::filesystem::path m_PDFLatexPath;
00087 boost::filesystem::path m_BibtexPath;
00088 boost::filesystem::path m_Latex2HTMLPath;
00089
00090 boost::filesystem::path m_CPreProcessorPath;
00091
00092 std::string m_ExtractedLatexDoc;
00093
00094 std::string m_Title;
00095 std::string m_NewCommands;
00096 std::string m_FuncID;
00097 std::string m_FuncName;
00098 std::string m_FuncVersion;
00099 std::string m_FuncAuthorName;
00100 std::string m_FuncAuthorEmail;
00101 std::string m_FuncDomain;
00102 std::string m_FuncDescription;
00103 std::string m_FuncData;
00104
00105 std::string m_BeginSignatureTag;
00106 std::string m_EndSignatureTag;
00107 std::string m_BeginFunc2DocTag;
00108 std::string m_EndFunc2DocTag;
00109
00110 std::string m_HTMLPackageLatexCommand;
00111
00112 SignatureData_t m_InVars;
00113 SignatureData_t m_OutVars;
00114 SignatureData_t m_ModVars;
00115 SignatureData_t m_InData;
00116 SignatureData_t m_ParamsData;
00117 SignatureData_t m_Events;
00118 SignatureData_t m_ExtraFiles;
00119
00120 std::string extractBetweenTags(std::string Content, const std::string BeginTag, const std::string EndTag);
00121
00122 std::string toLatexFriendly(std::string Content);
00123
00124 void addLatexDataCatBegin(std::string& Content, const std::string Title, const std::string ColsFormat);
00125
00126 void addLatexDataCatEnd(std::string& Content);
00127
00128 std::vector<std::string> extractSignatureLines();
00129
00130 std::vector<std::string> searchStringLitterals(std::string StrToParse);
00131
00132 void copyDocDirectory();
00133
00134 void extractLatexDocFromCPP();
00135
00136 void cpreprocessCPP();
00137
00138 void processSignature();
00139
00140 void generateLatex();
00141
00142 bool isErrorInPDFLatexLog();
00143
00144 void buildPDF();
00145
00146 void buildHTML();
00147
00148
00149 public:
00150
00151 Func2DocBuddy(openfluid::buddies::BuddiesListener* Listener);
00152
00153 ~Func2DocBuddy();
00154
00155 bool run();
00156
00157 };
00158
00159
00160 } }
00161
00162 #endif