├── src └── basically_ti_basic │ ├── __init__.py │ ├── __main__.py │ ├── compiler │ └── __init__.py │ ├── files │ └── __init__.py │ └── tokens │ └── __init__.py ├── .gitattributes ├── setup.py ├── LICENSE ├── .gitignore ├── 8XP_Format.md ├── README.md └── Doxyfile /src/basically_ti_basic/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | *.sln merge=union 7 | *.csproj merge=union 8 | *.vbproj merge=union 9 | *.fsproj merge=union 10 | *.dbproj merge=union 11 | 12 | # Standard to msysgit 13 | *.doc diff=astextplain 14 | *.DOC diff=astextplain 15 | *.docx diff=astextplain 16 | *.DOCX diff=astextplain 17 | *.dot diff=astextplain 18 | *.DOT diff=astextplain 19 | *.pdf diff=astextplain 20 | *.PDF diff=astextplain 21 | *.rtf diff=astextplain 22 | *.RTF diff=astextplain 23 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from setuptools import setup 4 | import sys 5 | import os 6 | 7 | install_requires = [ 8 | ] 9 | 10 | test_requires = [ 11 | ] 12 | 13 | data_files=[] 14 | 15 | 16 | setup(name='basically_ti_basic', 17 | version='0.1.2', 18 | description='Utilities for manipulating TI-Basic program files', 19 | author='Nate Levesque', 20 | author_email='public@thenaterhood.com', 21 | url='https://github.com/thenaterhood/basically-ti-basic/archive/master.zip', 22 | install_requires=install_requires, 23 | tests_require=test_requires, 24 | entry_points={ 25 | 'console_scripts': [ 26 | 'basically-ti-basic = basically_ti_basic.__main__:main', 27 | 'tibc = basically_ti_basic.__main__:main' 28 | ] 29 | }, 30 | test_suite='nose.collector', 31 | package_dir={'':'src'}, 32 | packages=[ 33 | 'basically_ti_basic', 34 | 'basically_ti_basic.compiler', 35 | 'basically_ti_basic.files', 36 | 'basically_ti_basic.tokens' 37 | ], 38 | data_files=data_files, 39 | package_data={ 40 | } 41 | ) 42 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 Nate Levesque 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /src/basically_ti_basic/__main__.py: -------------------------------------------------------------------------------- 1 | from basically_ti_basic.compiler import PrgmCompiler 2 | from basically_ti_basic.files import TIPrgmFile 3 | import argparse 4 | 5 | def compile_file(inputfile, outputfile): 6 | 7 | file_lines = [] 8 | with open(inputfile, 'r') as f: 9 | for line in f: 10 | file_lines.append(line) 11 | 12 | compiler = PrgmCompiler() 13 | compiled_file = compiler.compile(file_lines) 14 | if outputfile == "stdout": 15 | print("".join(compiled_file.prgmdata)) 16 | else: 17 | compiled_file.writeOut(outputfile) 18 | 19 | def decompile_file(inputfile, outputfile): 20 | tifile = TIPrgmFile(inputfile) 21 | 22 | compiler = PrgmCompiler() 23 | decompiled = compiler.decompile(tifile) 24 | if outputfile == 'stdout': 25 | print("\n".join(decompiled)) 26 | else: 27 | with open(outputfile, 'w') as out: 28 | for line in decompiled: 29 | out.write(line+"\n") 30 | 31 | def main(): 32 | parser = argparse.ArgumentParser() 33 | parser.add_argument( 34 | '-d', 35 | required=False, 36 | action="store_true", 37 | default=False, 38 | help="Decompile the passed file." 39 | ) 40 | parser.add_argument( 41 | '-c', 42 | required=False, 43 | action="store_true", 44 | default=False, 45 | help="Compile the passed file." 46 | ) 47 | parser.add_argument( 48 | '-o', 49 | required=False, 50 | default='stdout', 51 | help="Optional output file to write to. Defaults to standard out." 52 | ) 53 | parser.add_argument( 54 | '-i', 55 | required=True, 56 | help="Input file." 57 | ) 58 | 59 | args = parser.parse_args() 60 | 61 | if args.c: 62 | compile_file(args.i, args.o) 63 | 64 | elif args.d: 65 | decompile_file(args.i, args.o) 66 | 67 | if __name__ == "__main__": 68 | main() 69 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ################# 2 | ## Eclipse 3 | ################# 4 | 5 | *.pydevproject 6 | .project 7 | .metadata 8 | bin/ 9 | tmp/ 10 | *.tmp 11 | *.bak 12 | *.swp 13 | *~.nib 14 | local.properties 15 | .classpath 16 | .settings/ 17 | .loadpath 18 | 19 | # External tool builders 20 | .externalToolBuilders/ 21 | 22 | # Locally stored "Eclipse launch configurations" 23 | *.launch 24 | 25 | # CDT-specific 26 | .cproject 27 | 28 | # PDT-specific 29 | .buildpath 30 | 31 | 32 | ################# 33 | ## Visual Studio 34 | ################# 35 | 36 | ## Ignore Visual Studio temporary files, build results, and 37 | ## files generated by popular Visual Studio add-ons. 38 | 39 | # User-specific files 40 | *.suo 41 | *.user 42 | *.sln.docstates 43 | 44 | # Build results 45 | [Dd]ebug/ 46 | [Rr]elease/ 47 | *_i.c 48 | *_p.c 49 | *.ilk 50 | *.meta 51 | *.obj 52 | *.pch 53 | *.pdb 54 | *.pgc 55 | *.pgd 56 | *.rsp 57 | *.sbr 58 | *.tlb 59 | *.tli 60 | *.tlh 61 | *.tmp 62 | *.vspscc 63 | .builds 64 | *.dotCover 65 | 66 | ## TODO: If you have NuGet Package Restore enabled, uncomment this 67 | #packages/ 68 | 69 | # Visual C++ cache files 70 | ipch/ 71 | *.aps 72 | *.ncb 73 | *.opensdf 74 | *.sdf 75 | 76 | # Visual Studio profiler 77 | *.psess 78 | *.vsp 79 | 80 | # ReSharper is a .NET coding add-in 81 | _ReSharper* 82 | 83 | # Installshield output folder 84 | [Ee]xpress 85 | 86 | # DocProject is a documentation generator add-in 87 | DocProject/buildhelp/ 88 | DocProject/Help/*.HxT 89 | DocProject/Help/*.HxC 90 | DocProject/Help/*.hhc 91 | DocProject/Help/*.hhk 92 | DocProject/Help/*.hhp 93 | DocProject/Help/Html2 94 | DocProject/Help/html 95 | 96 | # Click-Once directory 97 | publish 98 | 99 | # Others 100 | [Bb]in 101 | [Oo]bj 102 | sql 103 | TestResults 104 | *.Cache 105 | ClientBin 106 | stylecop.* 107 | ~$* 108 | *.dbmdl 109 | Generated_Code #added for RIA/Silverlight projects 110 | 111 | # Backup & report files from converting an old project file to a newer 112 | # Visual Studio version. Backup files are not needed, because we have git ;-) 113 | _UpgradeReport_Files/ 114 | Backup*/ 115 | UpgradeLog*.XML 116 | 117 | 118 | 119 | ############ 120 | ## Windows 121 | ############ 122 | 123 | # Windows image file caches 124 | Thumbs.db 125 | 126 | # Folder config file 127 | Desktop.ini 128 | 129 | 130 | ############# 131 | ## Python 132 | ############# 133 | 134 | *.py[co] 135 | 136 | # Packages 137 | *.egg 138 | *.egg-info 139 | dist 140 | build 141 | eggs 142 | parts 143 | bin 144 | var 145 | sdist 146 | develop-eggs 147 | .installed.cfg 148 | 149 | # Installer logs 150 | pip-log.txt 151 | 152 | # Unit test / coverage reports 153 | .coverage 154 | .tox 155 | 156 | #Translations 157 | *.mo 158 | 159 | #Mr Developer 160 | .mr.developer.cfg 161 | 162 | # Mac crap 163 | .DS_Store 164 | 165 | ############################# 166 | # TheNaterhood testing stuff# 167 | ############################# 168 | FIBO2.txt 169 | FIBO2.8Xp 170 | INTRST2.txt 171 | INTRST2.8Xp 172 | PONG5.8Xp 173 | PONG52.8Xp 174 | PONG52.txt 175 | COUNT.8Xp 176 | FIBO.8Xp.txt 177 | -------------------------------------------------------------------------------- /8XP_Format.md: -------------------------------------------------------------------------------- 1 | 8Xp Files 2 | ========== 3 | The 8Xp files are fairly easy to decompile since they're basically only byte-compiled and fairly simple. 4 | The program works with them by running through and matching up bytes to what they represent in plaintext. 5 | After that, it cuts 72 bytes off the top of the file, which appears to be metadata and doesn't need 6 | to be decoded to plaintext (it holds no benefit) and cuts 3 bytes off the bottom of the file. Those 7 | 3 bytes don't appear to hold much importance because the file is still recognized without them. 8 | 9 | The metadata is a little bit more interesting and the Internet doesn't hold much information about it. 10 | The first 9 bytes are the same for every program and declare the type of file. Easy enough, it's: 11 | 12 | `**TI83F*[SUB][NEWLINE]` 13 | 14 | The next line holds a comment. The TI calculator uses this to datestamp the (creation?) of the file. The comment is 15 | 40 characters (bytes) long, preceded by and ending with a NUL character. Another NUL character follows then a hexadecimal 16 | value. The hexadecimal value doesn't seem to be extremely important as changing it arbitrarily in my test 17 | programs doesn't seem to have any effect on their being decompiled (online software doing the decoding since 18 | it's much pickier than mine). The byte after it however is a little more important and changing it does some weird 19 | things that I don't understand given my knowledge of the files. It appears to denote something regarding 20 | the size or length of the code since it stays the same for programs of the same relative size. Given that, the line 21 | looks something like: 22 | 23 | [NUL]40 character comment[NUL][NUL]hex value[NUL or STX looking at my program collection][NEWLINE] 24 | 25 | The next and final line is a little more interesting and much more crucial to the file actually being usable. 26 | It starts with a NUL character, followed by the size of the code (excluding the size of the metadata and footer). 27 | If this value is invalid it causes some bigger problems, as the decompiler used to confirm results will stop 28 | interpreting anything past the number of bytes the file claims to be. This is followed by a byte that functions 29 | as a carry bit. Since the maximum value a single byte can hold is 255, if the size of the program is over 255 bytes 30 | then the next byte is set. The next section of the line is the name of the program, starting 31 | with a [ENQ] character. The name is limited to 8 bytes, and therein capital letters. Any unused bytes are filled 32 | with [NUL] characters. The two bytes after this are [NUL] characters as well which might suggest that the file 33 | itself could permit longer names although the 8 characters is all that fits on the calculator screen's place 34 | for it. This is followed by the size again and a carry byte, like the second two characters of the line. 35 | After this is what appears to be the size - 2, and a carry byte for the size-2. So, put together 36 | the line ends up looking like this: 37 | 38 | [NUL]program size, carry byte[ENQ]prgmname[NUL][NUL]program size, carry byte, prgm size - 2, carry byte 39 | 40 | Then the compiled code for the program follows 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Basically, TI-Basic 2 | ======== 3 | [![Code Climate](https://codeclimate.com/github/thenaterhood/basically-ti-basic/badges/gpa.svg)](https://codeclimate.com/github/thenaterhood/basically-ti-basic) 4 | [![Codacy Badge](https://api.codacy.com/project/badge/grade/f1a58493247e491caecdd5d68b70620f)](https://www.codacy.com/app/thenaterhood/basically-ti-basic) 5 | [![Code Health](https://landscape.io/github/thenaterhood/basically-ti-basic/master/landscape.svg?style=flat)](https://landscape.io/github/basically-ti-basic/heartbeat/master) 6 | 7 | 8 | Software to make working with TI-Basic files much easier on the PC by decompiling 9 | and recompiling the .8Xp files from the TI-83/TI-84 calculators. For more 10 | information about the 8Xp file format, see the site listed in the credits and 11 | the 8XP_Format.md file, which contains additional reverse-engineered 12 | information. 13 | 14 | If you're looking for files to compile/decompile, you can find a number of 15 | TI programs at [github.com/thenaterhood/ti-programs](https://github.com/thenaterhood/ti-programs). 16 | 17 | Installation 18 | ------------ 19 | basically_ti_basic can be installed like any other typical Python package. 20 | Once Python (3+) is installed on the target system, simply clone the repository 21 | and navigate to the cloned repository in the command line. Once there, run 22 | `python setup.py install`. You should be good to go. 23 | 24 | Usage 25 | ------------ 26 | basically_ti_basic provides a command line utility and a few libraries. 27 | 28 | The command line utility should be available in your shell as the command 29 | `basically-ti-basic`. The utility allows for compilation and decompilation of 30 | TI-83+ .8Xp files. It provides the option to write the result to a file or 31 | print it to the console. Some usage examples: 32 | 33 | Open the file FIBO.8Xp, decompile it, and save the result to FIBO.txt 34 | 35 | `$ basically-ti-basic -d -i FIBO.8Xp -o FIBO.txt` 36 | 37 | Open the file FIBO.txt, compile it, and save the result to FIBO.8Xp 38 | 39 | `$ basically-ti-basic -c -i FIBO.txt -o FIBO.8Xp` 40 | 41 | Open the file FIBO.8Xp, decompile it, and print the result to the console 42 | 43 | `$ basically-ti-basic -d -i FIBO.8Xp` 44 | 45 | basically_ti_basic can also be imported into other applications. The libraries 46 | that may interest you the most are: 47 | 48 | * `basically_ti_basic.tokens`: Contains a dictionary of tokens to strings, and two functions for manipulating it (mainly, a flip so that the same dictionary can be used for compilation and decompilation). 49 | 50 | * `basically_ti_basic.compiler.PrgmCompiler`: Provides compilation and decompilation functionality. 51 | 52 | * `basically_ti_basic.files.TIPrgmFile`: Structure that represents a TI Program file and provides methods for generating the file headers. 53 | 54 | **Heads Up! The TI file creation (compilation) functionality is incomplete and 55 | may produce malformed files. Use it with caution and make sure to back up your 56 | calculator before loading any compiled files onto it.** 57 | 58 | 59 | LICENSE 60 | ------------ 61 | basically_ti_basic is licensed under the MIT license. The full license text 62 | can be found in the LICENSE file. 63 | 64 | If you find basically_ti_basic useful, use it regularly, or build something cool 65 | around it, please consider contributing, providing feedback or simply dropping a 66 | line to say that basically_ti_basic is useful to you. Feedback from users is 67 | what keeps open source projects strong. 68 | 69 | Credits 70 | ------------ 71 | Special thanks to [http://merthsoft.com/](http://merthsoft.com/) for their [TI-83+/TI-84+ Link Protocol Guide](http://merthsoft.com/linkguide/ti83+/index.html), which was a big help in writing sections of this software. 72 | -------------------------------------------------------------------------------- /src/basically_ti_basic/compiler/__init__.py: -------------------------------------------------------------------------------- 1 | from basically_ti_basic.tokens import get_tokens, get_inverse_tokens 2 | from basically_ti_basic.files import TIPrgmFile 3 | 4 | class PrgmCompiler(object): 5 | 6 | """ 7 | Handles compilation and decompilation of TIBasic .8Xp 8 | program files 9 | """ 10 | 11 | def compile(self, raw_text=None): 12 | """ 13 | Compiles to 8Xp format. This logic works, but the TIFile class is 14 | incomplete so the file may not work properly on the TI calculator. 15 | 16 | Parameters: 17 | Array[string] 18 | Returns: 19 | TIFile 20 | """ 21 | # To be compatible with Python 2.7 without changing 22 | # the public class API, we do some gross magic. This 23 | # has a side effect that we can use this method either 24 | # as a static method or not. 25 | # FIXME 26 | if not isinstance(self, PrgmCompiler): 27 | raw_text = self 28 | 29 | tifile = TIPrgmFile() 30 | tifile.prgmdata = [] 31 | tokens = get_inverse_tokens() 32 | prgm_string = "".join(raw_text) 33 | longest_prgm_string = max(len(k) for k in tokens.keys()) 34 | 35 | current_char = 0 36 | while current_char < len(prgm_string): 37 | found = False 38 | chars_further = longest_prgm_string 39 | # Greedily start with the maximum size string we have and back 40 | # down until we get to something that we can create a token from. 41 | while not found and chars_further > 0: 42 | try: 43 | token = tokens[prgm_string[current_char:current_char+chars_further]] 44 | found = True 45 | tifile.prgmdata.append(token) 46 | current_char += chars_further 47 | except: 48 | chars_further -= 1 49 | 50 | if chars_further <= 0: 51 | raise Exception("Something went horribly wrong while compiling.") 52 | 53 | return tifile 54 | 55 | 56 | def decompile(self, tifile=None): 57 | """ 58 | Decompiles to plaintext. 59 | 60 | Parameters: 61 | TIFile tifile: An open ti file to decompile 62 | Returns: 63 | Array[string] 64 | """ 65 | 66 | # To be compatible with Python 2.7 without changing 67 | # the public class API, we do some gross magic. This 68 | # has a side effect that we can use this method either 69 | # as a static method or not. 70 | # FIXME 71 | if not isinstance(self, PrgmCompiler): 72 | tifile = self 73 | 74 | prgm_data = tifile.prgmdata 75 | plaintext = [] 76 | tokens = get_tokens() 77 | 78 | byte_num = 0 79 | # Iterate until we hit the end of the program data 80 | while byte_num < len(prgm_data): 81 | 82 | curr_byte = prgm_data[byte_num] 83 | found_plaintext = '' 84 | 85 | # If the current byte exists in the tokens, see if we 86 | # can find a more specific one (2 bytes) that matches. If not, use 87 | # the first. We only need to worry about up to 2 bytes. 88 | if curr_byte in tokens.keys(): 89 | try: 90 | found_plaintext = tokens[curr_byte + prgm_data[byte_num+1]] 91 | byte_num += 2 92 | except: 93 | found_plaintext = tokens[curr_byte] 94 | byte_num += 1 95 | 96 | plaintext.append(found_plaintext) 97 | continue 98 | 99 | # If the current byte is not in the tokens, see if we can add 100 | # on the next byte to make it work. If so, use that, otherwise 101 | # spit out an error but do the rest. 102 | if curr_byte not in tokens.keys(): 103 | try: 104 | found_plaintext = tokens[curr_byte + prgm_data[byte_num+1]] 105 | plaintext.append(found_plaintext) 106 | byte_num += 2 107 | except: 108 | print("Could not decode " + str(curr_byte)) 109 | byte_num += 1 110 | 111 | return "".join(plaintext).split("\n") 112 | -------------------------------------------------------------------------------- /src/basically_ti_basic/files/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | author: Nate Levesque 3 | description: Reads and writes TI-Basic .8Xp files and returns 4 | structures relevant to the file if appropriate. 5 | 6 | TODO: 7 | add additional validation to the validate function 8 | 9 | figure out why when reading the file, the first byte 10 | goes missing 11 | """ 12 | 13 | class TIPrgmFile(object): 14 | """ 15 | Defines a data object to hold sections of a TI-Basic 16 | program file 17 | """ 18 | __slots__=('metadata', 'prgmdata', 'footer') 19 | 20 | def __init__(self, fname=None): 21 | """ 22 | Initializes the fields of the struct 23 | to empty fields if called without arguments or reads 24 | in a tiBasic file if a filename is given. 25 | 26 | Arguments: 27 | fname (str, optional): a 8xp filename to read 28 | """ 29 | 30 | if fname is not None: 31 | self.read(fname) 32 | else: 33 | self.metadata = None 34 | self.prgmdata = None 35 | self.footer = None 36 | 37 | def read(self, filename): 38 | """ 39 | Reads a TI-Basic .8xp file byte by byte 40 | and populates the fields of the data object that 41 | represents it 42 | 43 | Arguments: 44 | filename (str): the filename of a .8xp file to open, inc extension 45 | 46 | Returns: 47 | fileData (tiFile): a tiFile object 48 | 49 | """ 50 | 51 | # Reads the file into an array of bytes 52 | fileContents = [] 53 | with open(filename, "rb") as inStream: 54 | byte = inStream.read(1) 55 | while byte: 56 | byte = inStream.read(1) 57 | fileContents.append(byte) 58 | 59 | # Attempts to extract the metadata and raises an error 60 | # if the array is too short to contain any 61 | try: 62 | self.metadata = fileContents[:73] 63 | except: 64 | raise RuntimeError("File is too short to be a .8xp file.") 65 | 66 | # raises a warning if the array is too short to contain program 67 | # data and a footer 68 | if (len(fileContents) < 74): 69 | print("WARNING: File is only long enough to contain metadata.") 70 | self.prgmdata = None 71 | self.footer = None 72 | 73 | else: 74 | self.prgmdata = fileContents[73:len(fileContents)-3] 75 | self.footer = fileContents[len(fileContents)-3:len(fileContents)] 76 | 77 | def writeOut(self, filename): 78 | """ 79 | Writes a .8xp TI-Basic file to disk as bytes 80 | 81 | Arguments: 82 | filename (str): the name of the file to write 83 | 84 | Returns: 85 | fileWritten (boolean): a boolean value of whether or not the file 86 | has been written 87 | """ 88 | 89 | # Add the .8xp extension to the filename 90 | name = filename.split(".")[0].upper() 91 | self._createMetadata(name) 92 | 93 | with open(filename, "wb") as outFile: 94 | # Writes the program file to disk 95 | self._writeBytes(outFile, self.metadata) 96 | self._writeBytes(outFile, self.prgmdata) 97 | if self.footer is not None: 98 | self._writeBytes(outFile, self.footer) 99 | else: 100 | print("WARNING: No file footer data was generated.") 101 | 102 | def getMimetype(): 103 | """ 104 | Returns a list containing the bytes that define the mimetype 105 | of a TI-Basic .8Xp file 106 | 107 | Arguments: 108 | none 109 | Returns: 110 | (list): a list containing the bytes that define the mimetype 111 | of the TI 83 program files 112 | """ 113 | return [b'*',b'*',b'T',b'I',b'8',b'3',b'F',b'*',b'\x1a',b'\n'] 114 | 115 | def validate(self): 116 | """ 117 | Validates that a .8Xp file is actually a .8Xp file. 118 | Currently only checks sections of the metadata. For now 119 | is primarily so the decode program doesn't try decoding things 120 | that are not TI-Basic files. 121 | 122 | Arguments: 123 | self 124 | 125 | Returns: 126 | valid (boolean): a boolean value indicating if the file is valid 127 | """ 128 | fileType = self.metadata[:9] 129 | # Validating against bytes 1-9 of the mimetype. 130 | # for some reason the first byte of the file doesn't get read 131 | # which will need to be looked into 132 | 133 | if (fileType != TIPrgmFile.getMimetype()[1:]): 134 | return False 135 | 136 | return True 137 | 138 | def _writeBytes(self, openFile, data): 139 | """ 140 | Iterates through a list of bytes and writes them to a file. 141 | Arguments: 142 | openFile (file): an open file 143 | data (list): a list of bytes to write 144 | """ 145 | for byte in data: 146 | if (isinstance(byte, bytes)): 147 | openFile.write(byte) 148 | else: 149 | print("Error writing byte to file. Was '"+str(byte)+"'. Compiled file might have problems.") 150 | 151 | def __str__(self): 152 | """ 153 | Returns a string representation of the TI data object 154 | """ 155 | string = "TI File Data Object" 156 | if ( self.metadata ): 157 | string += "\n Contains metadata" 158 | if ( self.prgmdata ): 159 | string += "\n Contains program data" 160 | if ( self.footer ): 161 | string += "\n Contains footer data" 162 | 163 | return string 164 | 165 | def _convertSizeForHeader(self, size): 166 | """ 167 | Determines the size value to use for the compile TI-Basic header 168 | 169 | Arguments: 170 | size (int): the size in bytes of the data 171 | Returns: 172 | sizebytes (list): the size value and its following byte 173 | """ 174 | # The absolute largest possible size that the TI-Basic file is 175 | # allowed to be, based on current knowledge of the metadata. 176 | absoluteLimit = 255*255 177 | 178 | if (size >= absoluteLimit): 179 | # Raise an error, since the file size can't be beyond the 180 | # size defined in the absoluteLimit variable 181 | raise RuntimeError("File is beyond the allowed size for compiled TI-Basic files: yours: " +str(size) +", limit:" +str(absoluteLimit)) 182 | 183 | headerSize = [] 184 | 185 | carrybyte = bytes([size//255]) 186 | sizebyte = bytes([ size - (255 * (size // 255)) ]) 187 | headerSize.append(sizebyte) 188 | headerSize.append(carrybyte) 189 | 190 | # If the program is beyond the size that the file will allow, 191 | # an error needs to be raised because the file metadata doesn't 192 | # seem to make it possible for it to be larger. Current limit 193 | # appears to be 255*255 providing I can math tonight. 194 | 195 | return headerSize 196 | 197 | def _createMetadata(self, name): 198 | header = [] 199 | # Appends the TI83 filetype header to the header file, followed 200 | # by its newline. In ascii, header is **TI83F*[SUB][NEWLINE] 201 | filetype = TIPrgmFile.getMimetype() 202 | 203 | for item in filetype: 204 | header.append(item) 205 | 206 | # Appends a comment area of metadata to the header 207 | # Follows the form [NULL]40 characters[NULL]character[NULL][NULL][hex code][NEWLINE] 208 | # If the comment contains fewer than 40 characters, the unused 209 | # characters are filled with null characters. It appears that 210 | # more than 40 characters can be put here, but then the hex codes 211 | # at the end change. It doesn't seem to do anything, 212 | # but with over 40 characters it doesn't seem to be needed. 213 | # So, using the extra characters this section of the header becomes 214 | # [NULL]comment string, 42 chars[DC4][NULL][NEWLINE] 215 | 216 | # The comment appears to just be plain ASCII text, so not using 217 | # binary for it here. 218 | 219 | header.append(b'\x00') 220 | comment = "Encoding software from TheNaterhood....." 221 | for char in comment: 222 | header.append(char.encode('ascii', 'strict')) 223 | 224 | header.append(b'\x00') 225 | header.append(b'\x00') 226 | 227 | # This is the character that hasn't been figured out. It doesn't 228 | # seem to matter what it is so using N for now. 229 | header.append(b'N') 230 | 231 | # This is the hex code that does change per program but hasn't 232 | # been figured out yet. Using null for now to see if it makes 233 | # a difference 234 | header.append(b'\x00') 235 | header.append(b'\n') 236 | 237 | # This is a longer line. It contains information about the file 238 | # such as the name of the program and the size of the program. 239 | # It starts with a null character. 240 | 241 | header.append(b'\x00') 242 | 243 | # Next is the size of the file in bytes, so we take the contents 244 | # of the parsed file and just check the length since each byte is 245 | # an entry in the list. That gets added to the header. Adding 246 | # 2 since in comparison with known files, there always seems to be 2 247 | # bytes short, possibly because the file has no footer. 248 | 249 | size = (len(self.prgmdata)+2) 250 | 251 | header = header + self._convertSizeForHeader(size) 252 | 253 | # Add the null character that comes after the size. This is not 254 | # always a null character, but for now treating it as such to 255 | # see if it works. Will most likely work for smaller programs but 256 | # might be a problem for larger ones. Previous line now 257 | # also adds this byte. Worth noting: if there is an extra null 258 | # character at this point, the program is interpreted as a boxplot 259 | #header.append(b'\x00') 260 | 261 | # Adds the character that denotes the start of the name 262 | header.append(b'\x05') 263 | 264 | # Add the name of the file, which is limited to 8 characters and 265 | # followed by 2 NULL characters. 266 | 267 | # Create the series of bytes that holds the name. Splits the name 268 | # that's known into bytes and adds 9 null bytes after it to make sure 269 | # it is the right length. Then takes the first 9 bytes of the resulting 270 | nameAppend = [] 271 | name = name[0:9] 272 | 273 | for char in name: 274 | nameAppend.append(char.encode('ascii', 'strict')) 275 | 276 | while len(nameAppend) < 8: 277 | nameAppend.append(b'\x00') 278 | 279 | for char in nameAppend: 280 | header.append(char) 281 | 282 | header.append(b'\x00') 283 | header.append(b'\x00') 284 | 285 | # Adding the size a second time as it is repeated after the name 286 | header = header + self._convertSizeForHeader(size) 287 | 288 | # Adding the next value, which appears to be the number of bytes in the 289 | # file excluding the header -2. Consistent between different 290 | # program sizes 291 | header = header + self._convertSizeForHeader(size-2) 292 | 293 | self.metadata = header 294 | -------------------------------------------------------------------------------- /src/basically_ti_basic/tokens/__init__.py: -------------------------------------------------------------------------------- 1 | def get_tokens(): 2 | return _tokens 3 | 4 | def get_inverse_tokens(): 5 | flipped = dict() 6 | for key in _tokens: 7 | flipped[_tokens[key]] = key 8 | 9 | return flipped 10 | 11 | _tokens = dict([ 12 | (b'\x01', '>DMS'), 13 | (b'\x02', '>Dec'), 14 | (b'\x03', '>Frac'), 15 | (b'\x04', '→'), 16 | (b'\x05', 'BoxPlot'), 17 | (b'\x06', '['), 18 | (b'\x07', ']'), 19 | (b'\x08', '{'), 20 | (b'\x09', '}'), 21 | # I'm not sure what this operator is, so for now I'm not supporting it. 22 | # As-is, this may cause problems with building 8Xp files. 23 | # (b'\x0A', 'r'), 24 | (b'\x0B', '°'), 25 | (b'\x0C', '^-1'), 26 | (b'\x0D', '^2'), 27 | (b'\x0E', '^T'), 28 | (b'\x0F', '^3'), 29 | (b'\x10', '('), 30 | (b'\x11', ')'), 31 | (b'\x12', 'round('), 32 | (b'\x13', 'pxl-Test('), 33 | (b'\x14', 'augment('), 34 | (b'\x15', 'rowSwap('), 35 | (b'\x16', 'row+('), 36 | (b'\x17', '*row('), 37 | (b'\x18', '*row+('), 38 | (b'\x19', 'max('), 39 | (b'\x1A', 'min('), 40 | (b'\x1B', 'R>Pr('), 41 | (b'\x1C', 'R>P[theta]('), 42 | (b'\x1D', 'P>Rx('), 43 | (b'\x1E', 'P>Ry('), 44 | (b'\x1F', 'median('), 45 | (b'\x20', 'randM('), 46 | (b'\x21', 'mean('), 47 | (b'\x22', 'solve('), 48 | (b'\x23', 'seq('), 49 | (b'\x24', 'fnInt('), 50 | (b'\x25', 'nDeriv('), 51 | # Unknown function 52 | # (b'\x26', ''), 53 | (b'\x27', 'fMin('), 54 | (b'\x28', 'fMax('), 55 | (b'\x29', ' '), 56 | (b'\x2A', '"'), 57 | (b'\x2B', ','), 58 | (b'\x2C', 'imaginary'), 59 | (b'\x2D', '!'), 60 | (b'\x2E', 'CubicReg '), 61 | (b'\x2F', 'QuartReg '), 62 | (b'\x3A', '.'), 63 | # Alternate notation of E 64 | (b'\x3B', '10^'), 65 | (b'\x3C', ' or '), 66 | (b'\x3D', ' xor '), 67 | (b'\x3E', ':'), 68 | (b'\x3F', '\n'), 69 | (b'\x40', ' and '), 70 | (b'\x41', 'A'), 71 | (b'\x42', 'B'), 72 | (b'\x43', 'C'), 73 | (b'\x44', 'D'), 74 | (b'\x45', 'E'), 75 | (b'\x46', 'F'), 76 | (b'\x47', 'G'), 77 | (b'\x48', 'H'), 78 | (b'\x49', 'I'), 79 | (b'\x4A', 'J'), 80 | (b'\x4B', 'K'), 81 | (b'\x4C', 'L'), 82 | (b'\x4D', 'M'), 83 | (b'\x4E', 'N'), 84 | (b'\x4F', 'O'), 85 | (b'\x50', 'P'), 86 | (b'\x51', 'Q'), 87 | (b'\x52', 'R'), 88 | (b'\x53', 'S'), 89 | (b'\x54', 'T'), 90 | (b'\x55', 'U'), 91 | (b'\x56', 'V'), 92 | (b'\x57', 'W'), 93 | (b'\x58', 'X'), 94 | (b'\x59', 'Y'), 95 | (b'\x5A', 'Z'), 96 | (b'\x30', '0'), 97 | (b'\x31', '1'), 98 | (b'\x32', '2'), 99 | (b'\x33', '3'), 100 | (b'\x34', '4'), 101 | (b'\x35', '5'), 102 | (b'\x36', '6'), 103 | (b'\x37', '7'), 104 | (b'\x38', '8'), 105 | (b'\x39', '9'), 106 | (b'\x5B', '[theta]'), 107 | # System variables (incomplete: TODO) 108 | (b'\x5C\x00', '[A]'), 109 | (b'\x5C\x01', '[B]'), 110 | (b'\x5C\x02', '[C]'), 111 | (b'\x5C\x03', '[D]'), 112 | (b'\x5C\x04', '[E]'), 113 | (b'\x5C\x05', '[F]'), 114 | (b'\x5C\x06', '[G]'), 115 | (b'\x5C\x07', '[H]'), 116 | (b'\x5C\x08', '[I]'), 117 | (b'\x5C\x09', '[J]'), 118 | (b'\x5D\x00', 'l1'), 119 | (b'\x5D\x01', 'l2'), 120 | (b'\x5D\x02', 'l3'), 121 | (b'\x5D\x03', 'l4'), 122 | (b'\x5D\x04', 'l5'), 123 | (b'\x5D\x05', 'l6'), 124 | (b'\x5D\x06', 'l7'), 125 | (b'\x5D\x07', 'l8'), 126 | (b'\x5D\x08', 'l0'), 127 | (b'\x5E\x10', 'y1'), 128 | (b'\x5E\x11', 'y2'), 129 | (b'\x5E\x12', 'y3'), 130 | (b'\x5E\x13', 'y4'), 131 | (b'\x5E\x14', 'y5'), 132 | (b'\x5E\x15', 'y6'), 133 | (b'\x5E\x16', 'y7'), 134 | (b'\x5E\x17', 'y8'), 135 | (b'\x5E\x18', 'y9'), 136 | (b'\x5E\x19', 'y0'), 137 | (b'\x5E\x40', 'r_1'), 138 | (b'\x5E\x41', 'r_2'), 139 | (b'\x5E\x42', 'r_3'), 140 | (b'\x5E\x43', 'r_4'), 141 | (b'\x5E\x44', 'r_5'), 142 | (b'\x5E\x45', 'r_6'), 143 | # Not currently supported. Will cause problems with re-compiling 144 | #(b'\x5E\x80', 'u'), 145 | #(b'\x5E\x81', 'v'), 146 | (b'\x5E\x20', 'x1t'), 147 | (b'\x5E\x21', 'y1t'), 148 | (b'\x5E\x22', 'x2t'), 149 | (b'\x5E\x23', 'y2t'), 150 | (b'\x5E\x24', 'x3t'), 151 | (b'\x5E\x25', 'y3t'), 152 | (b'\x5E\x26', 'x4t'), 153 | (b'\x5E\x27', 'y4t'), 154 | (b'\x5E\x28', 'x5t'), 155 | (b'\x5E\x29', 'y5t'), 156 | (b'\x5E\x2A', 'x6t'), 157 | (b'\x5E\x2B', 'y6t'), 158 | # Unknown 159 | #(b'\x5E\x00', '') 160 | (b'\x5F', 'prgm'), 161 | (b'\x60\x00', 'Pic1'), 162 | (b'\x60\x01', 'Pic2'), 163 | (b'\x60\x02', 'Pic3'), 164 | (b'\x60\x03', 'Pic4'), 165 | (b'\x60\x04', 'Pic5'), 166 | (b'\x60\x05', 'Pic6'), 167 | (b'\x60\x06', 'Pic7'), 168 | (b'\x60\x07', 'Pic8'), 169 | (b'\x60\x08', 'Pic9'), 170 | (b'\x60\x09', 'Pic0'), 171 | (b'\x61\x00', 'GDB1'), 172 | (b'\x61\x01', 'GDB2'), 173 | (b'\x61\x02', 'GDB3'), 174 | (b'\x61\x03', 'GDB4'), 175 | (b'\x61\x04', 'GDB5'), 176 | (b'\x61\x05', 'GDB6'), 177 | (b'\x61\x06', 'GDB7'), 178 | (b'\x61\x07', 'GDB8'), 179 | (b'\x61\x08', 'GDB9'), 180 | (b'\x61\x09', 'GDB0'), 181 | # Unknown 182 | #(b'\x62\x00', ''), 183 | (b'\x62\x01', 'RegEq'), 184 | # Unsupported for now, will break parsing 185 | #(b'\x62\x02', 'n'), 186 | (b'\x62\x03', '[x-bar]'), 187 | (b'\x62\x04', '[Summ x]'), 188 | (b'\x62\x05', '[Summ x^2]'), 189 | (b'\x62\x06', 'Sx'), 190 | (b'\x62\x07', '[sigma]x'), 191 | (b'\x62\x08', 'minX'), 192 | (b'\x62\x09', 'maxX'), 193 | (b'\x62\x0A', 'minY'), 194 | (b'\x62\x0B', 'maxY'), 195 | (b'\x62\x0C', '[y-bar]'), 196 | (b'\x62\x0D', '[Summ y]'), 197 | (b'\x62\x0E', '[Summ y^2]'), 198 | (b'\x62\x0F', 'Sy'), 199 | (b'\x62\x10', '[sigma]y'), 200 | (b'\x62\x11', '[Summ xy]'), 201 | # Unsupported as-is, will break re-compiling 202 | #(b'\x62\x12', 'r'), 203 | (b'\x62\x13', 'Med'), 204 | (b'\x62\x14', 'Q1'), 205 | (b'\x62\x15', 'Q3'), 206 | # Unsupported as-is, will break re-compiling 207 | #(b'\x62\x16', 'a'), 208 | #(b'\x62\x17', 'b'), 209 | #(b'\x62\x18', 'c'), 210 | #(b'\x62\x19', 'd'), 211 | #(b'\x62\x1A', 'e'), 212 | (b'\x62\x1B', 'x1'), 213 | (b'\x62\x1C', 'x2'), 214 | (b'\x62\x1D', 'x3'), 215 | (b'\x62\x1E', 'y1'), 216 | (b'\x62\x1F', 'y2'), 217 | (b'\x62\x20', 'y3'), 218 | # Unsupported as-is, will break re-compiling 219 | #(b'\x62\x21', 'n'), 220 | #(b'\x62\x22', 'p'), 221 | #(b'\x62\x23', 'z'), 222 | #(b'\x62\x24', 't'), 223 | (b'\x62\x25', '[chi]2'), 224 | (b'\x62\x26', '[fin]'), 225 | (b'\x62\x27', 'df'), 226 | (b'\x62\x28', '[p-hat]'), 227 | (b'\x62\x29', '[p-hat]1'), 228 | (b'\x62\x2A', '[p-hat]2'), 229 | (b'\x62\x2B', '[x-bar]1'), 230 | (b'\x62\x2C', 'Sx1'), 231 | (b'\x62\x2D', 'n_1'), 232 | (b'\x62\x2E', '[x-bar]2'), 233 | (b'\x62\x2F', 'Sx2'), 234 | (b'\x62\x30', 'n_2'), 235 | (b'\x62\x31', 'Sxp'), 236 | (b'\x62\x32', 'lower'), 237 | (b'\x62\x33', 'upper'), 238 | # Unsupported as-is, will break re-compiling 239 | #(b'\x62\x34', 's'), 240 | (b'\x62\x35', 'r2'), 241 | (b'\x62\x36', 'R2'), 242 | # This may be a duplicate of the df above 243 | #(b'\x62\x37', 'df'), 244 | (b'\x62\x38', 'SS'), 245 | (b'\x62\x39', 'MS'), 246 | # More potential duplicates 247 | #(b'\x62\x3A', 'df'), 248 | #(b'\x62\x3B', 'SS'), 249 | #(b'\x62\x3C', 'MS'), 250 | (b'\x63\x00', 'ZXscl'), 251 | (b'\x63\x01', 'ZYscl'), 252 | (b'\x63\x02', 'Xscl'), 253 | (b'\x63\x03', 'Yscl'), 254 | (b'\x63\x04', 'U_nStart'), 255 | (b'\x63\x05', 'V_nStart'), 256 | (b'\x63\x06', 'U_(n-1)'), 257 | (b'\x63\x07', 'V_(n-1)'), 258 | # \x63\xx values are not complete 259 | (b'\x64', 'Radian'), 260 | (b'\x65', 'Degree'), 261 | (b'\x66', 'Normal'), 262 | (b'\x67', 'Sci'), 263 | (b'\x68', 'Eng'), 264 | (b'\x69', 'Float'), 265 | (b'\x6A', '='), 266 | (b'\x6B', '<'), 267 | (b'\x6C', '>'), 268 | (b'\x6D', '<='), 269 | (b'\x6E', '>='), 270 | (b'\x6F', '!='), 271 | (b'\x70', '+'), 272 | (b'\x71', '–'), 273 | (b'\x72', 'Ans'), 274 | (b'\x73', 'Fix '), 275 | (b'\x74', 'Horiz'), 276 | (b'\x75', 'Full'), 277 | (b'\x76', 'Func'), 278 | (b'\x77', 'Param'), 279 | (b'\x78', 'Polar'), 280 | (b'\x79', 'Seq'), 281 | (b'\x7A', 'IndpntAuto'), 282 | (b'\x7B', 'IndpntAsk'), 283 | (b'\x7C', 'DependAuto'), 284 | (b'\x7D', 'DependAsk'), 285 | # 73 ** (Graph Options) 286 | (b'\x7E\x00', 'Sequential'), 287 | (b'\x7E\x01', 'Simul'), 288 | (b'\x7E\x02', 'PolarGC'), 289 | (b'\x7E\x03', 'RectGC'), 290 | (b'\x7E\x04', 'CoordOn'), 291 | (b'\x7E\x05', 'CoordOff'), 292 | (b'\x7E\x06', 'Connected'), 293 | (b'\x7E\x07', 'Dot'), 294 | (b'\x7E\x08', 'AxesOn'), 295 | (b'\x7E\x09', 'AxesOff'), 296 | (b'\x7E\x0A', 'GridOn'), 297 | (b'\x7E\x0B', 'GridOff'), 298 | (b'\x7E\x0C', 'LabelOn'), 299 | (b'\x7E\x0D', 'LabelOff'), 300 | (b'\x7E\x0E', 'Web'), 301 | (b'\x7E\x0F', 'Time'), 302 | (b'\x7E\x10', 'uvAxes'), 303 | (b'\x7E\x11', 'vwAxes'), 304 | (b'\x7E\x12', 'uwAxes'), 305 | # End of 7E Options 306 | (b'\x7F', '[box]'), 307 | (b'\x80', '[cross]'), 308 | (b'\x81', '[dot]'), 309 | (b'\x82', '*'), 310 | (b'\x83', '/'), 311 | (b'\x84', 'Trace'), 312 | (b'\x85', 'ClrDraw'), 313 | (b'\x86', 'ZStandard'), 314 | (b'\x87', 'ZTrig'), 315 | (b'\x88', 'ZBox'), 316 | (b'\x89', 'Zoom_In'), 317 | (b'\x8A', 'Zoom_Out'), 318 | (b'\x8B', 'ZSquare'), 319 | (b'\x8C', 'ZInteger'), 320 | (b'\x8D', 'ZPrevious'), 321 | (b'\x8E', 'ZDecimal'), 322 | (b'\x8F', 'ZoomStat'), 323 | (b'\x90', 'ZoomRcl'), 324 | (b'\x91', 'PrintScreen'), 325 | (b'\x92', 'ZoomSto'), 326 | (b'\x93', 'Text('), 327 | (b'\x94', ' nPr '), 328 | (b'\x95', ' nCr '), 329 | (b'\x96', 'FnOn '), 330 | (b'\x97', 'FnOff '), 331 | (b'\x98', 'StorePic '), 332 | (b'\x99', 'RecallPic '), 333 | (b'\x9A', 'StoreGDB '), 334 | (b'\x9B', 'RecallGDB '), 335 | (b'\x9C', 'Line('), 336 | (b'\x9D', 'Vertical '), 337 | (b'\x9E', 'Pt-On('), 338 | (b'\x9F', 'Pt-Off('), 339 | (b'\xA0', 'Pt-Change( '), 340 | (b'\xA1', 'Pxl-On( '), 341 | (b'\xA2', 'Pxl-Off( '), 342 | (b'\xA3', 'Pxl-Change( '), 343 | (b'\xA4', 'Shade('), 344 | (b'\xA5', 'Circle('), 345 | (b'\xA6', 'Horizontal '), 346 | (b'\xA7', 'Tangent('), 347 | (b'\xA8', 'DrawInv '), 348 | (b'\xA9', 'DrawF '), 349 | # System variables (TODO) 350 | (b'\xAA\x00', 'Str1'), 351 | (b'\xAA\x01', 'Str2'), 352 | (b'\xAA\x02', 'Str3'), 353 | (b'\xAA\x03', 'Str4'), 354 | (b'\xAA\x04', 'Str5'), 355 | (b'\xAA\x05', 'Str6'), 356 | (b'\xAA\x06', 'Str7'), 357 | (b'\xAA\x07', 'Str8'), 358 | (b'\xAA\x08', 'Str9'), 359 | (b'\xAA\x09', 'Str0'), 360 | (b'\xAB', 'rand'), 361 | (b'\xAC', '[pi]'), 362 | (b'\xAD', 'getKey'), 363 | (b'\xAE', '\''), 364 | (b'\xAF', '?'), 365 | (b'\xB0', '-'), 366 | (b'\xB1', 'int('), 367 | (b'\xB2', 'abs('), 368 | (b'\xB3', 'det('), 369 | (b'\xB4', 'identity('), 370 | (b'\xB5', 'dim('), 371 | (b'\xB6', 'sum('), 372 | (b'\xB7', 'prod('), 373 | (b'\xB8', 'not('), 374 | (b'\xB9', 'iPart('), 375 | (b'\xBA', 'fPart('), 376 | # BB tokens (two-byte), Incomplete TODO 377 | (b'\xBB\x00', 'npv('), 378 | (b'\xBB\x01', 'irr('), 379 | (b'\xBB\x02', 'bal('), 380 | (b'\xBB\x03', 'SummPrn('), 381 | (b'\xBB\x04', 'SummInt('), 382 | (b'\xBB\x05', '>Nom('), 383 | (b'\xBB\x06', '>Eff('), 384 | (b'\xBB\x07', 'dbd('), 385 | (b'\xBB\x08', 'Icm('), 386 | (b'\xBB\x09', 'gcd('), 387 | (b'\xBB\x0A', 'randInt('), 388 | (b'\xBB\x0B', 'randBin('), 389 | (b'\xBB\x0C', 'sub('), 390 | (b'\xBB\x0D', 'stdDev('), 391 | (b'\xBB\x0E', 'variance('), 392 | (b'\xBB\x0F', 'inString('), 393 | (b'\xBB\xB0', 'a'), 394 | (b'\xBB\xB1', 'b'), 395 | (b'\xBB\xB2', 'c'), 396 | (b'\xBB\xB3', 'd'), 397 | (b'\xBB\xB4', 'e'), 398 | (b'\xBB\xB5', 'f'), 399 | (b'\xBB\xB6', 'g'), 400 | (b'\xBB\xB7', 'h'), 401 | (b'\xBB\xB8', 'i'), 402 | (b'\xBB\xB9', 'j'), 403 | (b'\xBB\xBA', 'k'), 404 | (b'\xBB\xBC', 'l'), 405 | (b'\xBB\xBD', 'm'), 406 | (b'\xBB\xBE', 'n'), 407 | (b'\xBB\xBF', 'o'), 408 | (b'\xBB\xC0', 'p'), 409 | (b'\xBB\xC1', 'q'), 410 | (b'\xBB\xC2', 'r'), 411 | (b'\xBB\xC3', 's'), 412 | (b'\xBB\xC4', 't'), 413 | (b'\xBB\xC5', 'u'), 414 | (b'\xBB\xC6', 'v'), 415 | (b'\xBB\xC7', 'w'), 416 | (b'\xBB\xC8', 'x'), 417 | (b'\xBB\xC9', 'y'), 418 | (b'\xBB\xCA', 'z'), 419 | # end of xBB 420 | (b'\xBC', 'sqrt('), 421 | (b'\xBD', 'cubrt('), 422 | (b'\xBE', 'ln ('), 423 | (b'\xBF', 'e^('), 424 | (b'\xC0', 'log('), 425 | (b'\xC1', '10^('), 426 | (b'\xC2', 'sin('), 427 | (b'\xC3', 'sin^-1('), 428 | (b'\xC4', 'cos('), 429 | (b'\xC5', 'cos^-1('), 430 | (b'\xC6', 'tan('), 431 | (b'\xC7', 'tan^-1('), 432 | (b'\xC8', 'sinh('), 433 | (b'\xC9', 'sinh^-1('), 434 | (b'\xCA', 'cosh('), 435 | (b'\xCB', 'cosh^-1('), 436 | (b'\xCC', 'tanh('), 437 | (b'\xCD', 'tanh^-1('), 438 | (b'\xCE', 'If '), 439 | (b'\xCF', 'Then'), 440 | (b'\xD0', 'Else'), 441 | (b'\xD1', 'While '), 442 | (b'\xD2', 'Repeat '), 443 | (b'\xD3', 'For '), 444 | (b'\xD4', 'End'), 445 | (b'\xD5', 'Return'), 446 | (b'\xD6', 'Lbl '), 447 | (b'\xD7', 'Goto '), 448 | (b'\xD8', 'Pause '), 449 | (b'\xD9', 'Stop'), 450 | (b'\xDA', 'IS>('), 451 | (b'\xDB', 'DS>('), 452 | (b'\xDC', 'Input '), 453 | (b'\xDD', 'Prompt '), 454 | (b'\xDE', 'Disp '), 455 | (b'\xDF', 'DispGraph'), 456 | (b'\xE0', 'Output('), 457 | (b'\xE1', 'ClrHome'), 458 | (b'\xE2', 'Fill('), 459 | (b'\xE3', 'SortA('), 460 | (b'\xE4', 'SortD('), 461 | (b'\xE5', 'DispTable'), 462 | (b'\xE6', 'Menu('), 463 | (b'\xE7', 'Send('), 464 | (b'\xE8', 'Get('), 465 | (b'\xE9', 'PlotsOn '), 466 | (b'\xEA', 'PlotsOff '), 467 | # No idea what this operator is, so we're not supporting it until I 468 | # know how it fits in things so encoding don't break with it 469 | #(b'\xEB', 'L'), 470 | (b'\xEC', 'Plot1('), 471 | (b'\xED', 'Plot2('), 472 | (b'\xEE', 'Plot3('), 473 | # Unknown 474 | #(b'\xEF', ''), 475 | (b'\xF0', '^'), 476 | (b'\xF1', '[xth root]'), 477 | (b'\xF2', '1-Var Stats '), 478 | (b'\xF3', '2-Var Stats '), 479 | (b'\xF4', 'LinReg(a+bx) '), 480 | (b'\xF5', 'ExpReg '), 481 | (b'\xF6', 'LnReg '), 482 | (b'\xF7', 'PwrReg '), 483 | (b'\xF8', 'Med-Med '), 484 | (b'\xF9', 'QuadReg '), 485 | (b'\xFA', 'ClrList '), 486 | (b'\xFB', 'ClrTable'), 487 | (b'\xFC', 'Histogram'), 488 | (b'\xFD', 'xyLine'), 489 | (b'\xFE', 'Scatter'), 490 | (b'\xFF', 'LinReg(ax+b) '), 491 | ]) 492 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.8 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "Basically TI Basic" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 | # to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = docs 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = YES 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = NO 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 209 | # new page for each member. If set to NO, the documentation of a member will be 210 | # part of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines. 230 | 231 | ALIASES = 232 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" 235 | # will allow you to use the command class in the itcl::class meaning. 236 | 237 | TCL_SUBST = 238 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 | # only. Doxygen will then generate output that is more tailored for C. For 241 | # instance, some of the names that are used will be different. The list of all 242 | # members will be omitted, etc. 243 | # The default value is: NO. 244 | 245 | OPTIMIZE_OUTPUT_FOR_C = NO 246 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 | # Python sources only. Doxygen will then generate output that is more tailored 249 | # for that language. For instance, namespaces will be presented as packages, 250 | # qualified scopes will look different, etc. 251 | # The default value is: NO. 252 | 253 | OPTIMIZE_OUTPUT_JAVA = NO 254 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 | # sources. Doxygen will then generate output that is tailored for Fortran. 257 | # The default value is: NO. 258 | 259 | OPTIMIZE_FOR_FORTRAN = NO 260 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 | # sources. Doxygen will then generate output that is tailored for VHDL. 263 | # The default value is: NO. 264 | 265 | OPTIMIZE_OUTPUT_VHDL = NO 266 | 267 | # Doxygen selects the parser to use depending on the extension of the files it 268 | # parses. With this tag you can assign which parser to use for a given 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it 270 | # using this tag. The format is ext=language, where ext is a file extension, and 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 | # 279 | # Note For files without extension you can use no_extension as a placeholder. 280 | # 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 | # the files are not read by doxygen. 283 | 284 | EXTENSION_MAPPING = 285 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 | # according to the Markdown format, which allows for more readable 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 | # The output of markdown processing is further processed by doxygen, so you can 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 | # case of backward compatibilities issues. 292 | # The default value is: YES. 293 | 294 | MARKDOWN_SUPPORT = YES 295 | 296 | # When enabled doxygen tries to link words that correspond to documented 297 | # classes, or namespaces to their corresponding documentation. Such a link can 298 | # be prevented in individual cases by by putting a % sign in front of the word 299 | # or globally by setting AUTOLINK_SUPPORT to NO. 300 | # The default value is: YES. 301 | 302 | AUTOLINK_SUPPORT = YES 303 | 304 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 305 | # to include (a tag file for) the STL sources as input, then you should set this 306 | # tag to YES in order to let doxygen match functions declarations and 307 | # definitions whose arguments contain STL classes (e.g. func(std::string); 308 | # versus func(std::string) {}). This also make the inheritance and collaboration 309 | # diagrams that involve STL classes more complete and accurate. 310 | # The default value is: NO. 311 | 312 | BUILTIN_STL_SUPPORT = NO 313 | 314 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 315 | # enable parsing support. 316 | # The default value is: NO. 317 | 318 | CPP_CLI_SUPPORT = NO 319 | 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 322 | # will parse them like normal C++ but will assume all classes use public instead 323 | # of private inheritance when no explicit protection keyword is present. 324 | # The default value is: NO. 325 | 326 | SIP_SUPPORT = NO 327 | 328 | # For Microsoft's IDL there are propget and propput attributes to indicate 329 | # getter and setter methods for a property. Setting this option to YES will make 330 | # doxygen to replace the get and set methods by a property in the documentation. 331 | # This will only work if the methods are indeed getting or setting a simple 332 | # type. If this is not the case, or you want to show the methods anyway, you 333 | # should set this option to NO. 334 | # The default value is: YES. 335 | 336 | IDL_PROPERTY_SUPPORT = YES 337 | 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 | # tag is set to YES, then doxygen will reuse the documentation of the first 340 | # member in the group (if any) for the other members of the group. By default 341 | # all members of a group must be documented explicitly. 342 | # The default value is: NO. 343 | 344 | DISTRIBUTE_GROUP_DOC = NO 345 | 346 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 347 | # (for instance a group of public functions) to be put as a subgroup of that 348 | # type (e.g. under the Public Functions section). Set it to NO to prevent 349 | # subgrouping. Alternatively, this can be done per class using the 350 | # \nosubgrouping command. 351 | # The default value is: YES. 352 | 353 | SUBGROUPING = YES 354 | 355 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 356 | # are shown inside the group in which they are included (e.g. using \ingroup) 357 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 358 | # and RTF). 359 | # 360 | # Note that this feature does not work in combination with 361 | # SEPARATE_MEMBER_PAGES. 362 | # The default value is: NO. 363 | 364 | INLINE_GROUPED_CLASSES = NO 365 | 366 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 367 | # with only public data fields or simple typedef fields will be shown inline in 368 | # the documentation of the scope in which they are defined (i.e. file, 369 | # namespace, or group documentation), provided this scope is documented. If set 370 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 371 | # Man pages) or section (for LaTeX and RTF). 372 | # The default value is: NO. 373 | 374 | INLINE_SIMPLE_STRUCTS = NO 375 | 376 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 377 | # enum is documented as struct, union, or enum with the name of the typedef. So 378 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 379 | # with name TypeT. When disabled the typedef will appear as a member of a file, 380 | # namespace, or class. And the struct will be named TypeS. This can typically be 381 | # useful for C code in case the coding convention dictates that all compound 382 | # types are typedef'ed and only the typedef is referenced, never the tag name. 383 | # The default value is: NO. 384 | 385 | TYPEDEF_HIDES_STRUCT = NO 386 | 387 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 388 | # cache is used to resolve symbols given their name and scope. Since this can be 389 | # an expensive process and often the same symbol appears multiple times in the 390 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 391 | # doxygen will become slower. If the cache is too large, memory is wasted. The 392 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 393 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 394 | # symbols. At the end of a run doxygen will report the cache usage and suggest 395 | # the optimal cache size from a speed point of view. 396 | # Minimum value: 0, maximum value: 9, default value: 0. 397 | 398 | LOOKUP_CACHE_SIZE = 0 399 | 400 | #--------------------------------------------------------------------------- 401 | # Build related configuration options 402 | #--------------------------------------------------------------------------- 403 | 404 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 405 | # documentation are documented, even if no documentation was available. Private 406 | # class members and static file members will be hidden unless the 407 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 408 | # Note: This will also disable the warnings about undocumented members that are 409 | # normally produced when WARNINGS is set to YES. 410 | # The default value is: NO. 411 | 412 | EXTRACT_ALL = NO 413 | 414 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 415 | # be included in the documentation. 416 | # The default value is: NO. 417 | 418 | EXTRACT_PRIVATE = NO 419 | 420 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 421 | # scope will be included in the documentation. 422 | # The default value is: NO. 423 | 424 | EXTRACT_PACKAGE = NO 425 | 426 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 427 | # included in the documentation. 428 | # The default value is: NO. 429 | 430 | EXTRACT_STATIC = NO 431 | 432 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 433 | # locally in source files will be included in the documentation. If set to NO 434 | # only classes defined in header files are included. Does not have any effect 435 | # for Java sources. 436 | # The default value is: YES. 437 | 438 | EXTRACT_LOCAL_CLASSES = YES 439 | 440 | # This flag is only useful for Objective-C code. When set to YES local methods, 441 | # which are defined in the implementation section but not in the interface are 442 | # included in the documentation. If set to NO only methods in the interface are 443 | # included. 444 | # The default value is: NO. 445 | 446 | EXTRACT_LOCAL_METHODS = NO 447 | 448 | # If this flag is set to YES, the members of anonymous namespaces will be 449 | # extracted and appear in the documentation as a namespace called 450 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 451 | # the file that contains the anonymous namespace. By default anonymous namespace 452 | # are hidden. 453 | # The default value is: NO. 454 | 455 | EXTRACT_ANON_NSPACES = NO 456 | 457 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 458 | # undocumented members inside documented classes or files. If set to NO these 459 | # members will be included in the various overviews, but no documentation 460 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 461 | # The default value is: NO. 462 | 463 | HIDE_UNDOC_MEMBERS = NO 464 | 465 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 466 | # undocumented classes that are normally visible in the class hierarchy. If set 467 | # to NO these classes will be included in the various overviews. This option has 468 | # no effect if EXTRACT_ALL is enabled. 469 | # The default value is: NO. 470 | 471 | HIDE_UNDOC_CLASSES = NO 472 | 473 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 474 | # (class|struct|union) declarations. If set to NO these declarations will be 475 | # included in the documentation. 476 | # The default value is: NO. 477 | 478 | HIDE_FRIEND_COMPOUNDS = NO 479 | 480 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 481 | # documentation blocks found inside the body of a function. If set to NO these 482 | # blocks will be appended to the function's detailed documentation block. 483 | # The default value is: NO. 484 | 485 | HIDE_IN_BODY_DOCS = NO 486 | 487 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 488 | # \internal command is included. If the tag is set to NO then the documentation 489 | # will be excluded. Set it to YES to include the internal documentation. 490 | # The default value is: NO. 491 | 492 | INTERNAL_DOCS = NO 493 | 494 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 495 | # names in lower-case letters. If set to YES upper-case letters are also 496 | # allowed. This is useful if you have classes or files whose names only differ 497 | # in case and if your file system supports case sensitive file names. Windows 498 | # and Mac users are advised to set this option to NO. 499 | # The default value is: system dependent. 500 | 501 | CASE_SENSE_NAMES = YES 502 | 503 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 504 | # their full class and namespace scopes in the documentation. If set to YES the 505 | # scope will be hidden. 506 | # The default value is: NO. 507 | 508 | HIDE_SCOPE_NAMES = NO 509 | 510 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 511 | # the files that are included by a file in the documentation of that file. 512 | # The default value is: YES. 513 | 514 | SHOW_INCLUDE_FILES = YES 515 | 516 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 517 | # grouped member an include statement to the documentation, telling the reader 518 | # which file to include in order to use the member. 519 | # The default value is: NO. 520 | 521 | SHOW_GROUPED_MEMB_INC = NO 522 | 523 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 524 | # files with double quotes in the documentation rather than with sharp brackets. 525 | # The default value is: NO. 526 | 527 | FORCE_LOCAL_INCLUDES = NO 528 | 529 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 530 | # documentation for inline members. 531 | # The default value is: YES. 532 | 533 | INLINE_INFO = YES 534 | 535 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 536 | # (detailed) documentation of file and class members alphabetically by member 537 | # name. If set to NO the members will appear in declaration order. 538 | # The default value is: YES. 539 | 540 | SORT_MEMBER_DOCS = YES 541 | 542 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 543 | # descriptions of file, namespace and class members alphabetically by member 544 | # name. If set to NO the members will appear in declaration order. Note that 545 | # this will also influence the order of the classes in the class list. 546 | # The default value is: NO. 547 | 548 | SORT_BRIEF_DOCS = NO 549 | 550 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 551 | # (brief and detailed) documentation of class members so that constructors and 552 | # destructors are listed first. If set to NO the constructors will appear in the 553 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 554 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 555 | # member documentation. 556 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 557 | # detailed member documentation. 558 | # The default value is: NO. 559 | 560 | SORT_MEMBERS_CTORS_1ST = NO 561 | 562 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 563 | # of group names into alphabetical order. If set to NO the group names will 564 | # appear in their defined order. 565 | # The default value is: NO. 566 | 567 | SORT_GROUP_NAMES = NO 568 | 569 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 570 | # fully-qualified names, including namespaces. If set to NO, the class list will 571 | # be sorted only by class name, not including the namespace part. 572 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 573 | # Note: This option applies only to the class list, not to the alphabetical 574 | # list. 575 | # The default value is: NO. 576 | 577 | SORT_BY_SCOPE_NAME = NO 578 | 579 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 580 | # type resolution of all parameters of a function it will reject a match between 581 | # the prototype and the implementation of a member function even if there is 582 | # only one candidate or it is obvious which candidate to choose by doing a 583 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 584 | # accept a match between prototype and implementation in such cases. 585 | # The default value is: NO. 586 | 587 | STRICT_PROTO_MATCHING = NO 588 | 589 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 590 | # todo list. This list is created by putting \todo commands in the 591 | # documentation. 592 | # The default value is: YES. 593 | 594 | GENERATE_TODOLIST = YES 595 | 596 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 597 | # test list. This list is created by putting \test commands in the 598 | # documentation. 599 | # The default value is: YES. 600 | 601 | GENERATE_TESTLIST = YES 602 | 603 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 604 | # list. This list is created by putting \bug commands in the documentation. 605 | # The default value is: YES. 606 | 607 | GENERATE_BUGLIST = YES 608 | 609 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 610 | # the deprecated list. This list is created by putting \deprecated commands in 611 | # the documentation. 612 | # The default value is: YES. 613 | 614 | GENERATE_DEPRECATEDLIST= YES 615 | 616 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 617 | # sections, marked by \if ... \endif and \cond 618 | # ... \endcond blocks. 619 | 620 | ENABLED_SECTIONS = 621 | 622 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 623 | # initial value of a variable or macro / define can have for it to appear in the 624 | # documentation. If the initializer consists of more lines than specified here 625 | # it will be hidden. Use a value of 0 to hide initializers completely. The 626 | # appearance of the value of individual variables and macros / defines can be 627 | # controlled using \showinitializer or \hideinitializer command in the 628 | # documentation regardless of this setting. 629 | # Minimum value: 0, maximum value: 10000, default value: 30. 630 | 631 | MAX_INITIALIZER_LINES = 30 632 | 633 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 634 | # the bottom of the documentation of classes and structs. If set to YES the list 635 | # will mention the files that were used to generate the documentation. 636 | # The default value is: YES. 637 | 638 | SHOW_USED_FILES = YES 639 | 640 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 641 | # will remove the Files entry from the Quick Index and from the Folder Tree View 642 | # (if specified). 643 | # The default value is: YES. 644 | 645 | SHOW_FILES = YES 646 | 647 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 648 | # page. This will remove the Namespaces entry from the Quick Index and from the 649 | # Folder Tree View (if specified). 650 | # The default value is: YES. 651 | 652 | SHOW_NAMESPACES = YES 653 | 654 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 655 | # doxygen should invoke to get the current version for each file (typically from 656 | # the version control system). Doxygen will invoke the program by executing (via 657 | # popen()) the command command input-file, where command is the value of the 658 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 659 | # by doxygen. Whatever the program writes to standard output is used as the file 660 | # version. For an example see the documentation. 661 | 662 | FILE_VERSION_FILTER = 663 | 664 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 665 | # by doxygen. The layout file controls the global structure of the generated 666 | # output files in an output format independent way. To create the layout file 667 | # that represents doxygen's defaults, run doxygen with the -l option. You can 668 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 669 | # will be used as the name of the layout file. 670 | # 671 | # Note that if you run doxygen from a directory containing a file called 672 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 673 | # tag is left empty. 674 | 675 | LAYOUT_FILE = /home/nate/projects/custom-doxygen/DoxygenLayout.xml 676 | 677 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 678 | # the reference definitions. This must be a list of .bib files. The .bib 679 | # extension is automatically appended if omitted. This requires the bibtex tool 680 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 681 | # For LaTeX the style of the bibliography can be controlled using 682 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 683 | # search path. See also \cite for info how to create references. 684 | 685 | CITE_BIB_FILES = 686 | 687 | #--------------------------------------------------------------------------- 688 | # Configuration options related to warning and progress messages 689 | #--------------------------------------------------------------------------- 690 | 691 | # The QUIET tag can be used to turn on/off the messages that are generated to 692 | # standard output by doxygen. If QUIET is set to YES this implies that the 693 | # messages are off. 694 | # The default value is: NO. 695 | 696 | QUIET = NO 697 | 698 | # The WARNINGS tag can be used to turn on/off the warning messages that are 699 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 700 | # this implies that the warnings are on. 701 | # 702 | # Tip: Turn warnings on while writing the documentation. 703 | # The default value is: YES. 704 | 705 | WARNINGS = YES 706 | 707 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 708 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 709 | # will automatically be disabled. 710 | # The default value is: YES. 711 | 712 | WARN_IF_UNDOCUMENTED = YES 713 | 714 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 715 | # potential errors in the documentation, such as not documenting some parameters 716 | # in a documented function, or documenting parameters that don't exist or using 717 | # markup commands wrongly. 718 | # The default value is: YES. 719 | 720 | WARN_IF_DOC_ERROR = YES 721 | 722 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 723 | # are documented, but have no documentation for their parameters or return 724 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter 725 | # documentation, but not about the absence of documentation. 726 | # The default value is: NO. 727 | 728 | WARN_NO_PARAMDOC = NO 729 | 730 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 731 | # can produce. The string should contain the $file, $line, and $text tags, which 732 | # will be replaced by the file and line number from which the warning originated 733 | # and the warning text. Optionally the format may contain $version, which will 734 | # be replaced by the version of the file (if it could be obtained via 735 | # FILE_VERSION_FILTER) 736 | # The default value is: $file:$line: $text. 737 | 738 | WARN_FORMAT = "$file:$line: $text" 739 | 740 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 741 | # messages should be written. If left blank the output is written to standard 742 | # error (stderr). 743 | 744 | WARN_LOGFILE = 745 | 746 | #--------------------------------------------------------------------------- 747 | # Configuration options related to the input files 748 | #--------------------------------------------------------------------------- 749 | 750 | # The INPUT tag is used to specify the files and/or directories that contain 751 | # documented source files. You may enter file names like myfile.cpp or 752 | # directories like /usr/src/myproject. Separate the files or directories with 753 | # spaces. 754 | # Note: If this tag is empty the current directory is searched. 755 | 756 | INPUT = README.md src 757 | 758 | # This tag can be used to specify the character encoding of the source files 759 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 760 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 761 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 762 | # possible encodings. 763 | # The default value is: UTF-8. 764 | 765 | INPUT_ENCODING = UTF-8 766 | 767 | # If the value of the INPUT tag contains directories, you can use the 768 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 769 | # *.h) to filter out the source-files in the directories. If left blank the 770 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 771 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 772 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 773 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 774 | # *.qsf, *.as and *.js. 775 | 776 | FILE_PATTERNS = *.py 777 | 778 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 779 | # be searched for input files as well. 780 | # The default value is: NO. 781 | 782 | RECURSIVE = YES 783 | 784 | # The EXCLUDE tag can be used to specify files and/or directories that should be 785 | # excluded from the INPUT source files. This way you can easily exclude a 786 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 787 | # 788 | # Note that relative paths are relative to the directory from which doxygen is 789 | # run. 790 | 791 | EXCLUDE = 792 | 793 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 794 | # directories that are symbolic links (a Unix file system feature) are excluded 795 | # from the input. 796 | # The default value is: NO. 797 | 798 | EXCLUDE_SYMLINKS = NO 799 | 800 | # If the value of the INPUT tag contains directories, you can use the 801 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 802 | # certain files from those directories. 803 | # 804 | # Note that the wildcards are matched against the file with absolute path, so to 805 | # exclude all test directories for example use the pattern */test/* 806 | 807 | EXCLUDE_PATTERNS = 808 | 809 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 810 | # (namespaces, classes, functions, etc.) that should be excluded from the 811 | # output. The symbol name can be a fully qualified name, a word, or if the 812 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 813 | # AClass::ANamespace, ANamespace::*Test 814 | # 815 | # Note that the wildcards are matched against the file with absolute path, so to 816 | # exclude all test directories use the pattern */test/* 817 | 818 | EXCLUDE_SYMBOLS = 819 | 820 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 821 | # that contain example code fragments that are included (see the \include 822 | # command). 823 | 824 | EXAMPLE_PATH = 825 | 826 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 827 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 828 | # *.h) to filter out the source-files in the directories. If left blank all 829 | # files are included. 830 | 831 | EXAMPLE_PATTERNS = 832 | 833 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 834 | # searched for input files to be used with the \include or \dontinclude commands 835 | # irrespective of the value of the RECURSIVE tag. 836 | # The default value is: NO. 837 | 838 | EXAMPLE_RECURSIVE = NO 839 | 840 | # The IMAGE_PATH tag can be used to specify one or more files or directories 841 | # that contain images that are to be included in the documentation (see the 842 | # \image command). 843 | 844 | IMAGE_PATH = 845 | 846 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 847 | # invoke to filter for each input file. Doxygen will invoke the filter program 848 | # by executing (via popen()) the command: 849 | # 850 | # 851 | # 852 | # where is the value of the INPUT_FILTER tag, and is the 853 | # name of an input file. Doxygen will then use the output that the filter 854 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 855 | # will be ignored. 856 | # 857 | # Note that the filter must not add or remove lines; it is applied before the 858 | # code is scanned, but not when the output code is generated. If lines are added 859 | # or removed, the anchors will not be placed correctly. 860 | 861 | INPUT_FILTER = 862 | 863 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 864 | # basis. Doxygen will compare the file name with each pattern and apply the 865 | # filter if there is a match. The filters are a list of the form: pattern=filter 866 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 867 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 868 | # patterns match the file name, INPUT_FILTER is applied. 869 | 870 | FILTER_PATTERNS = 871 | 872 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 873 | # INPUT_FILTER ) will also be used to filter the input files that are used for 874 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 875 | # The default value is: NO. 876 | 877 | FILTER_SOURCE_FILES = NO 878 | 879 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 880 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 881 | # it is also possible to disable source filtering for a specific pattern using 882 | # *.ext= (so without naming a filter). 883 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 884 | 885 | FILTER_SOURCE_PATTERNS = 886 | 887 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 888 | # is part of the input, its contents will be placed on the main page 889 | # (index.html). This can be useful if you have a project on for instance GitHub 890 | # and want to reuse the introduction page also for the doxygen output. 891 | 892 | USE_MDFILE_AS_MAINPAGE = README.md 893 | 894 | #--------------------------------------------------------------------------- 895 | # Configuration options related to source browsing 896 | #--------------------------------------------------------------------------- 897 | 898 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 899 | # generated. Documented entities will be cross-referenced with these sources. 900 | # 901 | # Note: To get rid of all source code in the generated output, make sure that 902 | # also VERBATIM_HEADERS is set to NO. 903 | # The default value is: NO. 904 | 905 | SOURCE_BROWSER = NO 906 | 907 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 908 | # classes and enums directly into the documentation. 909 | # The default value is: NO. 910 | 911 | INLINE_SOURCES = NO 912 | 913 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 914 | # special comment blocks from generated source code fragments. Normal C, C++ and 915 | # Fortran comments will always remain visible. 916 | # The default value is: YES. 917 | 918 | STRIP_CODE_COMMENTS = YES 919 | 920 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 921 | # function all documented functions referencing it will be listed. 922 | # The default value is: NO. 923 | 924 | REFERENCED_BY_RELATION = NO 925 | 926 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 927 | # all documented entities called/used by that function will be listed. 928 | # The default value is: NO. 929 | 930 | REFERENCES_RELATION = NO 931 | 932 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 933 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 934 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 935 | # link to the documentation. 936 | # The default value is: YES. 937 | 938 | REFERENCES_LINK_SOURCE = YES 939 | 940 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 941 | # source code will show a tooltip with additional information such as prototype, 942 | # brief description and links to the definition and documentation. Since this 943 | # will make the HTML file larger and loading of large files a bit slower, you 944 | # can opt to disable this feature. 945 | # The default value is: YES. 946 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 947 | 948 | SOURCE_TOOLTIPS = YES 949 | 950 | # If the USE_HTAGS tag is set to YES then the references to source code will 951 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 952 | # source browser. The htags tool is part of GNU's global source tagging system 953 | # (see http://www.gnu.org/software/global/global.html). You will need version 954 | # 4.8.6 or higher. 955 | # 956 | # To use it do the following: 957 | # - Install the latest version of global 958 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 959 | # - Make sure the INPUT points to the root of the source tree 960 | # - Run doxygen as normal 961 | # 962 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 963 | # tools must be available from the command line (i.e. in the search path). 964 | # 965 | # The result: instead of the source browser generated by doxygen, the links to 966 | # source code will now point to the output of htags. 967 | # The default value is: NO. 968 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 969 | 970 | USE_HTAGS = NO 971 | 972 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 973 | # verbatim copy of the header file for each class for which an include is 974 | # specified. Set to NO to disable this. 975 | # See also: Section \class. 976 | # The default value is: YES. 977 | 978 | VERBATIM_HEADERS = YES 979 | 980 | #--------------------------------------------------------------------------- 981 | # Configuration options related to the alphabetical class index 982 | #--------------------------------------------------------------------------- 983 | 984 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 985 | # compounds will be generated. Enable this if the project contains a lot of 986 | # classes, structs, unions or interfaces. 987 | # The default value is: YES. 988 | 989 | ALPHABETICAL_INDEX = YES 990 | 991 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 992 | # which the alphabetical index list will be split. 993 | # Minimum value: 1, maximum value: 20, default value: 5. 994 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 995 | 996 | COLS_IN_ALPHA_INDEX = 5 997 | 998 | # In case all classes in a project start with a common prefix, all classes will 999 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1000 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1001 | # while generating the index headers. 1002 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1003 | 1004 | IGNORE_PREFIX = 1005 | 1006 | #--------------------------------------------------------------------------- 1007 | # Configuration options related to the HTML output 1008 | #--------------------------------------------------------------------------- 1009 | 1010 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1011 | # The default value is: YES. 1012 | 1013 | GENERATE_HTML = YES 1014 | 1015 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1016 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1017 | # it. 1018 | # The default directory is: html. 1019 | # This tag requires that the tag GENERATE_HTML is set to YES. 1020 | 1021 | HTML_OUTPUT = html 1022 | 1023 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1024 | # generated HTML page (for example: .htm, .php, .asp). 1025 | # The default value is: .html. 1026 | # This tag requires that the tag GENERATE_HTML is set to YES. 1027 | 1028 | HTML_FILE_EXTENSION = .html 1029 | 1030 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1031 | # each generated HTML page. If the tag is left blank doxygen will generate a 1032 | # standard header. 1033 | # 1034 | # To get valid HTML the header file that includes any scripts and style sheets 1035 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1036 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1037 | # default header using 1038 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1039 | # YourConfigFile 1040 | # and then modify the file new_header.html. See also section "Doxygen usage" 1041 | # for information on how to generate the default header that doxygen normally 1042 | # uses. 1043 | # Note: The header is subject to change so you typically have to regenerate the 1044 | # default header when upgrading to a newer version of doxygen. For a description 1045 | # of the possible markers and block names see the documentation. 1046 | # This tag requires that the tag GENERATE_HTML is set to YES. 1047 | 1048 | HTML_HEADER = 1049 | 1050 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1051 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1052 | # footer. See HTML_HEADER for more information on how to generate a default 1053 | # footer and what special commands can be used inside the footer. See also 1054 | # section "Doxygen usage" for information on how to generate the default footer 1055 | # that doxygen normally uses. 1056 | # This tag requires that the tag GENERATE_HTML is set to YES. 1057 | 1058 | HTML_FOOTER = 1059 | 1060 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1061 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1062 | # the HTML output. If left blank doxygen will generate a default style sheet. 1063 | # See also section "Doxygen usage" for information on how to generate the style 1064 | # sheet that doxygen normally uses. 1065 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1066 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1067 | # obsolete. 1068 | # This tag requires that the tag GENERATE_HTML is set to YES. 1069 | 1070 | HTML_STYLESHEET = 1071 | 1072 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1073 | # cascading style sheets that are included after the standard style sheets 1074 | # created by doxygen. Using this option one can overrule certain style aspects. 1075 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1076 | # standard style sheet and is therefor more robust against future updates. 1077 | # Doxygen will copy the style sheet files to the output directory. 1078 | # Note: The order of the extra stylesheet files is of importance (e.g. the last 1079 | # stylesheet in the list overrules the setting of the previous ones in the 1080 | # list). For an example see the documentation. 1081 | # This tag requires that the tag GENERATE_HTML is set to YES. 1082 | 1083 | HTML_EXTRA_STYLESHEET = /home/nate/projects/custom-doxygen/customdoxygen.css 1084 | 1085 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1086 | # other source files which should be copied to the HTML output directory. Note 1087 | # that these files will be copied to the base HTML output directory. Use the 1088 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1089 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1090 | # files will be copied as-is; there are no commands or markers available. 1091 | # This tag requires that the tag GENERATE_HTML is set to YES. 1092 | 1093 | HTML_EXTRA_FILES = 1094 | 1095 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1096 | # will adjust the colors in the stylesheet and background images according to 1097 | # this color. Hue is specified as an angle on a colorwheel, see 1098 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1099 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1100 | # purple, and 360 is red again. 1101 | # Minimum value: 0, maximum value: 359, default value: 220. 1102 | # This tag requires that the tag GENERATE_HTML is set to YES. 1103 | 1104 | HTML_COLORSTYLE_HUE = 220 1105 | 1106 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1107 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1108 | # value of 255 will produce the most vivid colors. 1109 | # Minimum value: 0, maximum value: 255, default value: 100. 1110 | # This tag requires that the tag GENERATE_HTML is set to YES. 1111 | 1112 | HTML_COLORSTYLE_SAT = 100 1113 | 1114 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1115 | # luminance component of the colors in the HTML output. Values below 100 1116 | # gradually make the output lighter, whereas values above 100 make the output 1117 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1118 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1119 | # change the gamma. 1120 | # Minimum value: 40, maximum value: 240, default value: 80. 1121 | # This tag requires that the tag GENERATE_HTML is set to YES. 1122 | 1123 | HTML_COLORSTYLE_GAMMA = 80 1124 | 1125 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1126 | # page will contain the date and time when the page was generated. Setting this 1127 | # to NO can help when comparing the output of multiple runs. 1128 | # The default value is: YES. 1129 | # This tag requires that the tag GENERATE_HTML is set to YES. 1130 | 1131 | HTML_TIMESTAMP = YES 1132 | 1133 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1134 | # documentation will contain sections that can be hidden and shown after the 1135 | # page has loaded. 1136 | # The default value is: NO. 1137 | # This tag requires that the tag GENERATE_HTML is set to YES. 1138 | 1139 | HTML_DYNAMIC_SECTIONS = NO 1140 | 1141 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1142 | # shown in the various tree structured indices initially; the user can expand 1143 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1144 | # such a level that at most the specified number of entries are visible (unless 1145 | # a fully collapsed tree already exceeds this amount). So setting the number of 1146 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1147 | # representing an infinite number of entries and will result in a full expanded 1148 | # tree by default. 1149 | # Minimum value: 0, maximum value: 9999, default value: 100. 1150 | # This tag requires that the tag GENERATE_HTML is set to YES. 1151 | 1152 | HTML_INDEX_NUM_ENTRIES = 100 1153 | 1154 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1155 | # generated that can be used as input for Apple's Xcode 3 integrated development 1156 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1157 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1158 | # Makefile in the HTML output directory. Running make will produce the docset in 1159 | # that directory and running make install will install the docset in 1160 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1161 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1162 | # for more information. 1163 | # The default value is: NO. 1164 | # This tag requires that the tag GENERATE_HTML is set to YES. 1165 | 1166 | GENERATE_DOCSET = NO 1167 | 1168 | # This tag determines the name of the docset feed. A documentation feed provides 1169 | # an umbrella under which multiple documentation sets from a single provider 1170 | # (such as a company or product suite) can be grouped. 1171 | # The default value is: Doxygen generated docs. 1172 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1173 | 1174 | DOCSET_FEEDNAME = "Doxygen generated docs" 1175 | 1176 | # This tag specifies a string that should uniquely identify the documentation 1177 | # set bundle. This should be a reverse domain-name style string, e.g. 1178 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1179 | # The default value is: org.doxygen.Project. 1180 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1181 | 1182 | DOCSET_BUNDLE_ID = org.doxygen.Project 1183 | 1184 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1185 | # the documentation publisher. This should be a reverse domain-name style 1186 | # string, e.g. com.mycompany.MyDocSet.documentation. 1187 | # The default value is: org.doxygen.Publisher. 1188 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1189 | 1190 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1191 | 1192 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1193 | # The default value is: Publisher. 1194 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1195 | 1196 | DOCSET_PUBLISHER_NAME = Publisher 1197 | 1198 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1199 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1200 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1201 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1202 | # Windows. 1203 | # 1204 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1205 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1206 | # files are now used as the Windows 98 help format, and will replace the old 1207 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1208 | # HTML files also contain an index, a table of contents, and you can search for 1209 | # words in the documentation. The HTML workshop also contains a viewer for 1210 | # compressed HTML files. 1211 | # The default value is: NO. 1212 | # This tag requires that the tag GENERATE_HTML is set to YES. 1213 | 1214 | GENERATE_HTMLHELP = NO 1215 | 1216 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1217 | # file. You can add a path in front of the file if the result should not be 1218 | # written to the html output directory. 1219 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1220 | 1221 | CHM_FILE = 1222 | 1223 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1224 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty 1225 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1226 | # The file has to be specified with full path. 1227 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1228 | 1229 | HHC_LOCATION = 1230 | 1231 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1232 | # YES) or that it should be included in the master .chm file ( NO). 1233 | # The default value is: NO. 1234 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1235 | 1236 | GENERATE_CHI = NO 1237 | 1238 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1239 | # and project file content. 1240 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1241 | 1242 | CHM_INDEX_ENCODING = 1243 | 1244 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1245 | # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it 1246 | # enables the Previous and Next buttons. 1247 | # The default value is: NO. 1248 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1249 | 1250 | BINARY_TOC = NO 1251 | 1252 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1253 | # the table of contents of the HTML help documentation and to the tree view. 1254 | # The default value is: NO. 1255 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1256 | 1257 | TOC_EXPAND = NO 1258 | 1259 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1260 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1261 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1262 | # (.qch) of the generated HTML documentation. 1263 | # The default value is: NO. 1264 | # This tag requires that the tag GENERATE_HTML is set to YES. 1265 | 1266 | GENERATE_QHP = NO 1267 | 1268 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1269 | # the file name of the resulting .qch file. The path specified is relative to 1270 | # the HTML output folder. 1271 | # This tag requires that the tag GENERATE_QHP is set to YES. 1272 | 1273 | QCH_FILE = 1274 | 1275 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1276 | # Project output. For more information please see Qt Help Project / Namespace 1277 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1278 | # The default value is: org.doxygen.Project. 1279 | # This tag requires that the tag GENERATE_QHP is set to YES. 1280 | 1281 | QHP_NAMESPACE = org.doxygen.Project 1282 | 1283 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1284 | # Help Project output. For more information please see Qt Help Project / Virtual 1285 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1286 | # folders). 1287 | # The default value is: doc. 1288 | # This tag requires that the tag GENERATE_QHP is set to YES. 1289 | 1290 | QHP_VIRTUAL_FOLDER = doc 1291 | 1292 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1293 | # filter to add. For more information please see Qt Help Project / Custom 1294 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1295 | # filters). 1296 | # This tag requires that the tag GENERATE_QHP is set to YES. 1297 | 1298 | QHP_CUST_FILTER_NAME = 1299 | 1300 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1301 | # custom filter to add. For more information please see Qt Help Project / Custom 1302 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1303 | # filters). 1304 | # This tag requires that the tag GENERATE_QHP is set to YES. 1305 | 1306 | QHP_CUST_FILTER_ATTRS = 1307 | 1308 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1309 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1310 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1311 | # This tag requires that the tag GENERATE_QHP is set to YES. 1312 | 1313 | QHP_SECT_FILTER_ATTRS = 1314 | 1315 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1316 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1317 | # generated .qhp file. 1318 | # This tag requires that the tag GENERATE_QHP is set to YES. 1319 | 1320 | QHG_LOCATION = 1321 | 1322 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1323 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1324 | # install this plugin and make it available under the help contents menu in 1325 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1326 | # to be copied into the plugins directory of eclipse. The name of the directory 1327 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1328 | # After copying Eclipse needs to be restarted before the help appears. 1329 | # The default value is: NO. 1330 | # This tag requires that the tag GENERATE_HTML is set to YES. 1331 | 1332 | GENERATE_ECLIPSEHELP = NO 1333 | 1334 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1335 | # the directory name containing the HTML and XML files should also have this 1336 | # name. Each documentation set should have its own identifier. 1337 | # The default value is: org.doxygen.Project. 1338 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1339 | 1340 | ECLIPSE_DOC_ID = org.doxygen.Project 1341 | 1342 | # If you want full control over the layout of the generated HTML pages it might 1343 | # be necessary to disable the index and replace it with your own. The 1344 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1345 | # of each HTML page. A value of NO enables the index and the value YES disables 1346 | # it. Since the tabs in the index contain the same information as the navigation 1347 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1348 | # The default value is: NO. 1349 | # This tag requires that the tag GENERATE_HTML is set to YES. 1350 | 1351 | DISABLE_INDEX = NO 1352 | 1353 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1354 | # structure should be generated to display hierarchical information. If the tag 1355 | # value is set to YES, a side panel will be generated containing a tree-like 1356 | # index structure (just like the one that is generated for HTML Help). For this 1357 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1358 | # (i.e. any modern browser). Windows users are probably better off using the 1359 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1360 | # further fine-tune the look of the index. As an example, the default style 1361 | # sheet generated by doxygen has an example that shows how to put an image at 1362 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1363 | # the same information as the tab index, you could consider setting 1364 | # DISABLE_INDEX to YES when enabling this option. 1365 | # The default value is: NO. 1366 | # This tag requires that the tag GENERATE_HTML is set to YES. 1367 | 1368 | GENERATE_TREEVIEW = NO 1369 | 1370 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1371 | # doxygen will group on one line in the generated HTML documentation. 1372 | # 1373 | # Note that a value of 0 will completely suppress the enum values from appearing 1374 | # in the overview section. 1375 | # Minimum value: 0, maximum value: 20, default value: 4. 1376 | # This tag requires that the tag GENERATE_HTML is set to YES. 1377 | 1378 | ENUM_VALUES_PER_LINE = 4 1379 | 1380 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1381 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1382 | # Minimum value: 0, maximum value: 1500, default value: 250. 1383 | # This tag requires that the tag GENERATE_HTML is set to YES. 1384 | 1385 | TREEVIEW_WIDTH = 250 1386 | 1387 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1388 | # external symbols imported via tag files in a separate window. 1389 | # The default value is: NO. 1390 | # This tag requires that the tag GENERATE_HTML is set to YES. 1391 | 1392 | EXT_LINKS_IN_WINDOW = NO 1393 | 1394 | # Use this tag to change the font size of LaTeX formulas included as images in 1395 | # the HTML documentation. When you change the font size after a successful 1396 | # doxygen run you need to manually remove any form_*.png images from the HTML 1397 | # output directory to force them to be regenerated. 1398 | # Minimum value: 8, maximum value: 50, default value: 10. 1399 | # This tag requires that the tag GENERATE_HTML is set to YES. 1400 | 1401 | FORMULA_FONTSIZE = 10 1402 | 1403 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1404 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1405 | # supported properly for IE 6.0, but are supported on all modern browsers. 1406 | # 1407 | # Note that when changing this option you need to delete any form_*.png files in 1408 | # the HTML output directory before the changes have effect. 1409 | # The default value is: YES. 1410 | # This tag requires that the tag GENERATE_HTML is set to YES. 1411 | 1412 | FORMULA_TRANSPARENT = YES 1413 | 1414 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1415 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1416 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX 1417 | # installed or if you want to formulas look prettier in the HTML output. When 1418 | # enabled you may also need to install MathJax separately and configure the path 1419 | # to it using the MATHJAX_RELPATH option. 1420 | # The default value is: NO. 1421 | # This tag requires that the tag GENERATE_HTML is set to YES. 1422 | 1423 | USE_MATHJAX = NO 1424 | 1425 | # When MathJax is enabled you can set the default output format to be used for 1426 | # the MathJax output. See the MathJax site (see: 1427 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1428 | # Possible values are: HTML-CSS (which is slower, but has the best 1429 | # compatibility), NativeMML (i.e. MathML) and SVG. 1430 | # The default value is: HTML-CSS. 1431 | # This tag requires that the tag USE_MATHJAX is set to YES. 1432 | 1433 | MATHJAX_FORMAT = HTML-CSS 1434 | 1435 | # When MathJax is enabled you need to specify the location relative to the HTML 1436 | # output directory using the MATHJAX_RELPATH option. The destination directory 1437 | # should contain the MathJax.js script. For instance, if the mathjax directory 1438 | # is located at the same level as the HTML output directory, then 1439 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1440 | # Content Delivery Network so you can quickly see the result without installing 1441 | # MathJax. However, it is strongly recommended to install a local copy of 1442 | # MathJax from http://www.mathjax.org before deployment. 1443 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1444 | # This tag requires that the tag USE_MATHJAX is set to YES. 1445 | 1446 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1447 | 1448 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1449 | # extension names that should be enabled during MathJax rendering. For example 1450 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1451 | # This tag requires that the tag USE_MATHJAX is set to YES. 1452 | 1453 | MATHJAX_EXTENSIONS = 1454 | 1455 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1456 | # of code that will be used on startup of the MathJax code. See the MathJax site 1457 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1458 | # example see the documentation. 1459 | # This tag requires that the tag USE_MATHJAX is set to YES. 1460 | 1461 | MATHJAX_CODEFILE = 1462 | 1463 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1464 | # the HTML output. The underlying search engine uses javascript and DHTML and 1465 | # should work on any modern browser. Note that when using HTML help 1466 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1467 | # there is already a search function so this one should typically be disabled. 1468 | # For large projects the javascript based search engine can be slow, then 1469 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1470 | # search using the keyboard; to jump to the search box use + S 1471 | # (what the is depends on the OS and browser, but it is typically 1472 | # , /