diff --git a/Doxyfile b/Doxyfile index a3d45a1..cdefb86 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,13 +38,13 @@ PROJECT_NAME = "sapphirec" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "0.1" +PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "The Sapphire compiler." +PROJECT_BRIEF = "The Sapphire compiler" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = "docs/" +OUTPUT_DIRECTORY = docs # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -195,7 +195,7 @@ SHORT_NAMES = NO # description.) # The default value is: NO. -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as @@ -365,7 +365,7 @@ AUTOLINK_SUPPORT = YES # diagrams that involve STL classes more complete and accurate. # The default value is: NO. -BUILTIN_STL_SUPPORT = YES +BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. @@ -445,7 +445,7 @@ INLINE_SIMPLE_STRUCTS = NO # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. -TYPEDEF_HIDES_STRUCT = YES +TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be @@ -893,7 +893,51 @@ INPUT_ENCODING = UTF-8 # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, # *.ucf, *.qsf and *.ice. -FILE_PATTERNS = *.h *.cpp +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -908,7 +952,7 @@ RECURSIVE = NO # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = */tclap-1.2.5/* */FormatString/* +EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -924,7 +968,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = */tclap*/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the diff --git a/docs/html/Arguments_8h_source.html b/docs/html/Arguments_8h_source.html index 8702b03..d1828c4 100644 --- a/docs/html/Arguments_8h_source.html +++ b/docs/html/Arguments_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/Error_8h_source.html b/docs/html/Error_8h_source.html index deb3fbd..e620d30 100644 --- a/docs/html/Error_8h_source.html +++ b/docs/html/Error_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/FileIO_8h_source.html b/docs/html/FileIO_8h_source.html index ae7b5ee..b3c7239 100644 --- a/docs/html/FileIO_8h_source.html +++ b/docs/html/FileIO_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/Importer_8h_source.html b/docs/html/Importer_8h_source.html index cf09dd1..7ae3071 100644 --- a/docs/html/Importer_8h_source.html +++ b/docs/html/Importer_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/Lexer_8h_source.html b/docs/html/Lexer_8h_source.html index 4729514..c25c981 100644 --- a/docs/html/Lexer_8h_source.html +++ b/docs/html/Lexer_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/Location_8h_source.html b/docs/html/Location_8h_source.html index 650a24c..16d9b68 100644 --- a/docs/html/Location_8h_source.html +++ b/docs/html/Location_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/Normalizer_8h_source.html b/docs/html/Normalizer_8h_source.html index c8d58c9..abdc9a7 100644 --- a/docs/html/Normalizer_8h_source.html +++ b/docs/html/Normalizer_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/Parser_8h_source.html b/docs/html/Parser_8h_source.html index 290bd57..6822bd2 100644 --- a/docs/html/Parser_8h_source.html +++ b/docs/html/Parser_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/Token_8h_source.html b/docs/html/Token_8h_source.html index 2f21225..64c5539 100644 --- a/docs/html/Token_8h_source.html +++ b/docs/html/Token_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 898e07a..0a0144d 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/classLexer-members.html b/docs/html/classLexer-members.html index a7ff3a6..bdfe950 100644 --- a/docs/html/classLexer-members.html +++ b/docs/html/classLexer-members.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/classLexer.html b/docs/html/classLexer.html index bbf7fe1..6d008ac 100644 --- a/docs/html/classLexer.html +++ b/docs/html/classLexer.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/classParser-members.html b/docs/html/classParser-members.html index 1e2c93f..c76854a 100644 --- a/docs/html/classParser-members.html +++ b/docs/html/classParser-members.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/classParser.html b/docs/html/classParser.html index c4fc2e6..e2ddd33 100644 --- a/docs/html/classParser.html +++ b/docs/html/classParser.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/class____benchmark__impl-members.html b/docs/html/class____benchmark__impl-members.html index eea4eb9..bd2714d 100644 --- a/docs/html/class____benchmark__impl-members.html +++ b/docs/html/class____benchmark__impl-members.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/class____benchmark__impl.html b/docs/html/class____benchmark__impl.html index 1d28f82..64c5909 100644 --- a/docs/html/class____benchmark__impl.html +++ b/docs/html/class____benchmark__impl.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/classes.html b/docs/html/classes.html index f804c00..036d109 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index ee0e41c..fa8b858 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/files.html b/docs/html/files.html index 59e168e..574c6df 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/index.html b/docs/html/index.html index da4fae1..2c5d128 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/sapphirepch_8h_source.html b/docs/html/sapphirepch_8h_source.html index 7d8fc48..2a8c874 100644 --- a/docs/html/sapphirepch_8h_source.html +++ b/docs/html/sapphirepch_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/structArguments-members.html b/docs/html/structArguments-members.html index a276281..4c7b6a6 100644 --- a/docs/html/structArguments-members.html +++ b/docs/html/structArguments-members.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/structArguments.html b/docs/html/structArguments.html index b8542ab..9b81338 100644 --- a/docs/html/structArguments.html +++ b/docs/html/structArguments.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/structLocation-members.html b/docs/html/structLocation-members.html index 4e4cff4..5829ca5 100644 --- a/docs/html/structLocation-members.html +++ b/docs/html/structLocation-members.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/structLocation.html b/docs/html/structLocation.html index ccfa03e..87eccdf 100644 --- a/docs/html/structLocation.html +++ b/docs/html/structLocation.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/structToken-members.html b/docs/html/structToken-members.html index 931e5a0..2ca3b19 100644 --- a/docs/html/structToken-members.html +++ b/docs/html/structToken-members.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/structToken.html b/docs/html/structToken.html index 723fccd..4557c75 100644 --- a/docs/html/structToken.html +++ b/docs/html/structToken.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
diff --git a/docs/html/utils_8h_source.html b/docs/html/utils_8h_source.html index 2fef7bd..52aa16a 100644 --- a/docs/html/utils_8h_source.html +++ b/docs/html/utils_8h_source.html @@ -22,9 +22,8 @@
sapphirec -  0.1
-
The Sapphire compiler.
+
The Sapphire compiler
@@ -71,48 +70,54 @@ $(function() {
utils.h
-
1 #pragma once
-
2 #include "FormatString/FormatString.hpp"
-
3 #include "sapphirepch.h"
-
4 #include <chrono>
-
5 
-
6 /*
-
7  * Replaces all ocurrences of a substring with another one in a string.
-
8  * @param[in] str The input string.
-
9  * @param[in] from The substring to remove.
-
10  * @param[in] to The substring to add.
-
11  * @param[out] replaced Whether anything was replaced.
-
12  */
-
13 bool replace(std::string& str, const std::string& from, const std::string& to);
-
14 
-
15 /* Easy way of converting an int to a string without writing 5 lines of code every time you want to do it. */
-
16 std::string to_string(const int& value);
-
17 
-
18 /* Easy way of converting a float to a string without writing 5 lines of code every time you want to do it. */
-
19 std::string to_string(const float& value);
+
1 /*
+
2  * @file utils.h
+
3  * Miscellaneous utilities to use in the compiler, such as string manipulation/conversion
+
4  * functions, and benchmarking utilities.
+
5  */
+
6 
+
7 #pragma once
+
8 #include "FormatString/FormatString.hpp"
+
9 #include "sapphirepch.h"
+
10 #include <chrono>
+
11 
+
12 /*
+
13  * Replaces all ocurrences of a substring with another one in a string.
+
14  * @param[in] str The input string.
+
15  * @param[in] from The substring to remove.
+
16  * @param[in] to The substring to add.
+
17  * @param[out] replaced Whether anything was replaced.
+
18  */
+
19 bool replace(std::string& str, const std::string& from, const std::string& to);
20 
-
21 /* Benchmarking utilities. */
-
22 
-
23 class __benchmark_impl
-
24 {
-
25  public:
-
26  __benchmark_impl(std::string_view __function_name);
-
27  ~__benchmark_impl();
+
21 /* Easy way of converting an int to a string without writing 5 lines of code every time you want to do it. */
+
22 std::string to_string(const int& value);
+
23 
+
24 /* Easy way of converting a float to a string without writing 5 lines of code every time you want to do it. */
+
25 std::string to_string(const float& value);
+
26 
+
27 /* Benchmarking utilities. */
28 
-
29  static void enable();
-
30  static void disable();
-
31 
-
32  static void init();
-
33 
-
34  private:
-
35  std::chrono::time_point<std::chrono::high_resolution_clock> m_StartTimePoint;
-
36  std::string_view m_FunctionName;
-
37  static bool m_BenchmarkingEnabled;
-
38  bool m_InternalBenchmarkingEnabled;
-
39 };
-
40 
-
41 #define benchmark(message) __benchmark_impl __benchmark_impl_timer(message)
-
__benchmark_impl
Definition: utils.h:24
+
29 class __benchmark_impl
+
30 {
+
31  public:
+
32  __benchmark_impl(std::string_view __function_name);
+
33  ~__benchmark_impl();
+
34 
+
35  static void enable();
+
36  static void disable();
+
37 
+
38  static void init();
+
39 
+
40  private:
+
41  std::chrono::time_point<std::chrono::high_resolution_clock> m_StartTimePoint;
+
42  std::string_view m_FunctionName;
+
43  static bool m_BenchmarkingEnabled;
+
44  bool m_InternalBenchmarkingEnabled;
+
45 };
+
46 
+
47 #define benchmark(message) __benchmark_impl __benchmark_impl_timer(message)
+
__benchmark_impl
Definition: utils.h:30
diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index 1627c28..a5700e4 100644 --- a/docs/latex/refman.tex +++ b/docs/latex/refman.tex @@ -158,7 +158,7 @@ \begin{titlepage} \vspace*{7cm} \begin{center}% -{\Large sapphirec \\[1ex]\large 0.\+1 }\\ +{\Large sapphirec }\\ \vspace*{1cm} {\large Generated by Doxygen 1.9.1}\\ \end{center}