SPEC-7531 Change Code/CryEngine to Code/Legacy (#1634)

* git mv Code\CryEngine Code\Legacy * redirecting CMakeLists.txt * fixing uic warning * Some more CryEngine mentions * validation scripts Signed-off-by: Esteban Papp <81431996+amznestebanpapp@users.noreply.github.com>
2021-06-29 13:51:24 -07:00
parent f570925c0d
commit 9f0bbf3b74
384 changed files with 25 additions and 31 deletions
@@ -0,0 +1,122 @@
+/*
+ * Copyright (c) Contributors to the Open 3D Engine Project
+ * 
+ * SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ */
+
+
+#pragma once
+#ifndef CRYINCLUDE_CRYSYSTEM_CONSOLEHELPGEN_H
+#define CRYINCLUDE_CRYSYSTEM_CONSOLEHELPGEN_H
+
+#if defined(WIN32) || defined(WIN64)
+
+#include "XConsole.h"           // CXConsole, struct string_nocase_lt
+
+
+// extract consoel variable and command help
+// in some HTML pages and many small files that can be included in Confluence wiki
+// pages (so maintain the documentation only in one place)
+//
+// Possible improvements/Known issues:
+//   - Nicer HTML layout (CSS?)
+//   - Searching in the content of the cvars is tricky (main page doesn't have help content)
+//   - %TODO% (was wiki image, should look good in confluence and HTML)
+//   - many small files should be stored in some extra folder for clearity
+//   - before generating the data the older directoy should be cleaned
+//   - file should be generated in the user folder
+//   - "wb" should be used instead of "w", to get the same result in unix
+class CConsoleHelpGen
+{
+public:
+    CConsoleHelpGen(CXConsole& rParent)
+        : m_rParent(rParent)
+        , m_eWorkMode(eWM_None)
+    {
+    }
+
+    void Work();
+
+private: // --------------------------------------------------------
+
+    enum EWorkMode
+    {
+        eWM_None,
+        eWM_HTML,
+        eWM_Confluence
+    };
+
+    //
+    void CreateMainPages();
+
+    // to create one file for for each cvar/command in confluence style
+    void CreateFileForEachEntry();
+
+    // insert if the name starts with the with prefix
+    void InsertConsoleVars(std::set<const char*, string_nocase_lt>& setCmdAndVars, const char* szPrefix) const;
+    // insert if the name starts with the with prefix
+    void InsertConsoleCommands(std::set<const char*, string_nocase_lt>& setCmdAndVars, const char* szPrefix) const;
+    // insert if the name does not start with any of the prefix in the map
+    void InsertConsoleVars(std::set<const char*, string_nocase_lt>& setCmdAndVars, std::map<string, const char*> mapPrefix) const;
+    // insert if the name does not start with any of the prefix in the map
+    void InsertConsoleCommands(std::set<const char*, string_nocase_lt>& setCmdAndVars, std::map<string, const char*> mapPrefix) const;
+
+    // a single file for the entry is generate
+    void CreateSingleEntryFile(const char* szName) const;
+
+    void IncludeSingleEntry(FILE* f, const char* szName) const;
+
+    static string FixAnchorName(const char* szName);
+    static string GetCleanPrefix(const char* p);
+    // split before "|" (to get the prefix itself)
+    static string SplitPrefixString_Part1(const char* p);
+    // split string after "|" (to get the optional help)
+    static const char* SplitPrefixString_Part2(const char* p);
+
+    void StartPage(FILE* f, const char* szPageName, const char* szPageDescription) const;
+    void EndPage(FILE* f) const;
+    void StartH1(FILE* f, const char* szName) const;
+    void EndH1(FILE* f) const;
+    void StartH3(FILE* f, const char* szName) const;
+    void EndH3(FILE* f) const;
+    void StartCVar(FILE* f, const char* szName) const;
+    void EndCVar(FILE* f) const;
+    void SingleLinePrefix(FILE* f, const char* szPrefix, const char* szPrefixDesc, const char* szLink) const;
+    void StartPrefix(FILE* f, const char* szPrefix, const char* szPrefixDesc, const char* szLink) const;
+    void EndPrefix(FILE* f) const;
+    void SingleLineEntry_InGlobal(FILE* f, const char* szName, const char* szLink) const;
+    void SingleLineEntry_InGroup(FILE* f, const char* szName, const char* szLink) const;
+    void Anchor(FILE* f, const char* szName) const;
+
+    // to log some inital stats like date or application name
+    void KeyValue(FILE* f, const char* szKey, const char* szValue) const;
+
+    // prefix explanation and indention for following text
+    void Explanation(FILE* f, const char* szText) const;
+
+    void Separator(FILE* f) const;
+
+    void LogVersion(FILE* f) const;
+
+    // case senstive
+    // Returns
+    //   0 if not found
+    const CConsoleCommand* FindConsoleCommand(const char* szName) const;
+
+    // ----------------------------------------------
+
+    //
+    const char* GetFolderName() const;
+    //
+    const char* GetFileExtension() const;
+
+    // ----------------------------------------------
+
+    CXConsole&                           m_rParent;
+    EWorkMode                               m_eWorkMode;                // during Work() thise true:HTML and false:Confluence at some point
+};
+
+
+#endif  // defined(WIN32) || defined(WIN64)
+#endif // CRYINCLUDE_CRYSYSTEM_CONSOLEHELPGEN_H