├── __init__.py ├── tools ├── __init__.py ├── nifdoc │ ├── __init__.py │ └── nifdoc_tmpl.py └── nifxml │ ├── __init__.py │ ├── utility.py │ └── nifxml.py ├── .gitattributes ├── doc ├── favicon.ico └── nifdoc.css ├── .gitignore ├── nifdoc.py └── LICENSE /__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tools/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tools/nifdoc/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | *.xml text 3 | -------------------------------------------------------------------------------- /doc/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/niftools/nifxml/HEAD/doc/favicon.ico -------------------------------------------------------------------------------- /tools/nifxml/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | All the publicly available imports from __all__ 3 | """ 4 | 5 | from .nifxml import * # pylint: disable=W0401 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # Generated html 7 | *.html 8 | 9 | # VS Code 10 | .vscode/* 11 | 12 | /venv 13 | /.idea/ 14 | -------------------------------------------------------------------------------- /tools/nifxml/utility.py: -------------------------------------------------------------------------------- 1 | """ 2 | Utility functions for nifxml module 3 | """ 4 | 5 | import sys 6 | 7 | 8 | def export(clsorfn): 9 | """Export decorator""" 10 | mod = sys.modules[clsorfn.__module__] 11 | if hasattr(mod, '__all__'): 12 | mod.__all__.append(clsorfn.__name__) 13 | else: 14 | mod.__all__ = [clsorfn.__name__] 15 | return clsorfn 16 | -------------------------------------------------------------------------------- /doc/nifdoc.css: -------------------------------------------------------------------------------- 1 | hr { border: 1px; color: black; background: black; height: 1px; } 2 | body { font-family: Verdana, Arial, Helvetica, sans-serif; } 3 | p, td, th, div, pre, li { color: black; font-size: 10pt; } 4 | td { vertical-align: text-top; } 5 | a { color: #2087bb; text-decoration: none;} 6 | a:link { color: #2087bb; text-decoration: none;} 7 | a:visited { color: #2087bb; text-decoration: none;} 8 | a:active { text-decoration: none;} 9 | a:hover { color: #DD6900; text-decoration: underline;} 10 | 11 | table { width: 100%; } 12 | th { font-weight: bold; color: black; background: #D3DCE3} 13 | h1 { text-align: center; color: black; background: #FF6600; } 14 | h2 { text-align: center; color: black; background: #FFCC33; } 15 | h3 { text-align: left; color: black; background: #FFCC66; } 16 | a:link { text-decoration: none; color: #2087bb; background: transparent; } 17 | a:visited { text-decoration: none; color: #2087bb; background: transparent; } 18 | a:hover { text-decoration: underline; color: #DD6900; background: transparent; } 19 | a:link.nav { color: #000000; background: transparent; } 20 | a:visited.nav { color: #000000; background: transparent; } 21 | a:hover.nav { color: #FF0000; background: transparent; } 22 | .nav { color: #000000; background: transparent; } 23 | tr { background: #DDDDDD; color: black; } 24 | tr.odd { background: #DDDDDD; color: black; } 25 | tr.even { background: #EEEEEE; color: black; } 26 | 27 | td.aname { white-space: nowrap; } 28 | td.atype { white-space: nowrap; } 29 | td.aarg { font-size: small; font-family: 'Courier New', Courier, monospace; } 30 | td.alength { font-size: small; font-family: 'Courier New', Courier, monospace; } 31 | td.awidth { font-size: small; font-family: 'Courier New', Courier, monospace; } 32 | td.acond { font-size: small; font-family: 'Courier New', Courier, monospace; } 33 | -------------------------------------------------------------------------------- /tools/nifdoc/nifdoc_tmpl.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """ 3 | This file is part of nifxml 4 | Copyright (c) 2017 NifTools 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, version 3. 9 | 10 | This program is distributed in the hope that it will be useful, but 11 | WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | """ 18 | from __future__ import unicode_literals 19 | 20 | UL_ITEM = '\n' 21 | LI_LINK = '\t
  • {1}
    • \n' 22 | LI_LINK_DESC = '
  • {1} | {2}
    • \n' 23 | TYPE_LINK = '{1}' 24 | TMPL_LINK = '<{1}>' 25 | 26 | MAIN_BEG = """ 27 | 28 | 29 | \tNIF File Format Documentation - {title} 30 | \t 31 | \t 32 | 33 | """ 34 | MAIN_END = """ 35 | \t

    NIF Objects | Struct Types 36 | \t| Enum Types | Basic Types | File Versions

    37 | \t{contents} 38 | 39 | """ 40 | 41 | # Main HTML template with and without H1 heading 42 | MAIN_H1 = MAIN_BEG + '

    NIF File Format Documentation

    ' + MAIN_END 43 | MAIN_NO_H1 = MAIN_BEG + MAIN_END 44 | 45 | # Attribute row with metadata 46 | ATTR = """ 47 | 48 | \t{attr_name} 49 | \t{attr_type} 50 | \t{attr_arg} 51 | \t{attr_length} 52 | \t{attr_width} 53 | \t{attr_cond} 54 | \t{attr_desc} 55 | \t{attr_from} 56 | \t{attr_to} 57 | 58 | """ 59 | 60 | # Attribute row without metadata 61 | ATTR_NO_META = """ 62 | 63 | \t{attr_name} 64 | \t{attr_type} 65 | \t{attr_desc} 66 | 67 | """ 68 | 69 | # List for Found In 70 | FOUND_IN = """ 71 |

    Found In

    72 | 75 | """ 76 | 77 | # List for Parent Of 78 | PARENT_OF = """ 79 |

    Parent Of

    80 | """ 83 | 84 | # Basic layout 85 | BASIC = """ 86 |

    {name}

    87 | {description} 88 | 89 |

    Can Be Used As Array Size

    90 |

    {count}

    91 | """ + FOUND_IN 92 | 93 | # Block with metadata columns 94 | BLOCK = """ 95 |

    {name}

    96 | {description} 97 |

    Attributes

    98 | 99 | \t 100 | \t\t 101 | \t\t 102 | \t\t 103 | \t\t 104 | \t\t 105 | \t\t 106 | \t\t 107 | \t\t 108 | \t 109 | \t{attributes} 110 |
    NameTypeArgLengthWidthCondDescriptionFromTo
    111 | """ 112 | 113 | # Block without metadata columns 114 | BLOCK_NM = """ 115 |

    {name}

    116 | {description} 117 |

    Attributes

    118 | 119 | \t 120 | \t\t 121 | \t\t 122 | \t\t 123 | \t 124 | \t{attributes} 125 |
    NameTypeDescription
    126 | """ 127 | 128 | # Struct and NiObject with and without metadata columns 129 | STRUCT = BLOCK + FOUND_IN 130 | NIOBJECT = BLOCK + PARENT_OF 131 | STRUCT_NO_META = BLOCK_NM + FOUND_IN 132 | NIOBJECT_NO_META = BLOCK_NM + PARENT_OF 133 | 134 | # Object tree for index.html 135 | HIERARCHY = """ 136 | """ 137 | 138 | # Object list for *_list.html 139 | LIST = """ 140 | 141 | \t 142 | \t\t 143 | \t\t 144 | \t 145 | {list} 146 |
    {list_header}Description
    """ 147 | 148 | # Navbar 149 | NAV = """

    Hierarchy | List

    150 |

    {title}

    151 | """ 152 | 153 | # Nav plus contents 154 | NAV_LIST = NAV + LIST 155 | NAV_HIER = NAV + HIERARCHY 156 | 157 | # Enum layout 158 | ENUM = """ 159 |

    {name}

    160 | {description} 161 | 162 |

    Choices

    163 | 164 | \t 165 | \t\t 166 | \t\t 167 | \t\t 168 | \t 169 | \t{choices} 170 |
    NumberNameDescription
    171 | 172 |

    Storage Type

    173 | {storage} 174 | """ + FOUND_IN 175 | 176 | ENUM_ROW = """ 177 | 178 | \t{enum_number} 179 | \t{enum_name} 180 | \t{enum_desc} 181 | 182 | """ 183 | 184 | INHERIT_ROW = """ 185 | 186 | \tFrom {inherit} 187 | 188 | """ 189 | 190 | INHERIT_NO_META = """ 191 | 192 | \tFrom {inherit} 193 | 194 | """ 195 | 196 | LIST_ROW = """ 197 | 198 | \t{list_name} 199 | \t{list_desc} 200 | """ 201 | 202 | VERSION_ROW = """ 203 | 204 | \t{list_name} 205 | \t{list_desc} 206 | 207 | """ 208 | -------------------------------------------------------------------------------- /nifdoc.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """ 3 | nifdoc.py 4 | 5 | Generates HTML documentation for the XML file. 6 | 7 | To list command line options run: 8 | nifdoc.py -h 9 | 10 | This file is part of nifxml 11 | Copyright (c) 2017 NifTools 12 | 13 | This program is free software: you can redistribute it and/or modify 14 | it under the terms of the GNU General Public License as published by 15 | the Free Software Foundation, version 3. 16 | 17 | This program is distributed in the hope that it will be useful, but 18 | WITHOUT ANY WARRANTY; without even the implied warranty of 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20 | General Public License for more details. 21 | 22 | You should have received a copy of the GNU General Public License 23 | along with this program. If not, see . 24 | """ 25 | 26 | from __future__ import unicode_literals 27 | 28 | import re 29 | import os 30 | import io 31 | import logging 32 | import argparse 33 | from shutil import copy2 34 | 35 | from tools.nifxml import Struct, Block, Enum, parse_xml, version2number 36 | from tools.nifxml import TYPES_BLOCK, TYPES_BASIC, TYPES_STRUCT, TYPES_ENUM, TYPES_FLAG, TYPES_VERSION 37 | from tools.nifxml import NAMES_BLOCK, NAMES_BASIC, NAMES_STRUCT, NAMES_ENUM, NAMES_FLAG, NAMES_VERSION 38 | 39 | from tools.nifdoc import nifdoc_tmpl as tmpl 40 | 41 | # 42 | # Globals 43 | # 44 | 45 | SCRIPT_PATH = os.path.dirname(os.path.realpath(__file__)) 46 | DOC_PATH = '/doc/' 47 | DOC_FILE = '{}.html' 48 | CSS_PATH = os.path.join(SCRIPT_PATH, 'doc/nifdoc.css') 49 | ICO_PATH = os.path.join(SCRIPT_PATH, 'doc/favicon.ico') 50 | 51 | 52 | def clean(string): 53 | """Removes everything but letters from a string""" 54 | pattern = re.compile(r'[\W_]+') 55 | return pattern.sub('', string) 56 | 57 | 58 | def main(): 59 | """Parses the XML and generates all doc pages""" 60 | # Parse the XML and sort names 61 | if not parse_xml(): 62 | return 63 | 64 | NAMES_BASIC.sort() 65 | NAMES_STRUCT.sort() 66 | NAMES_BLOCK.sort() 67 | NAMES_ENUM.sort() 68 | NAMES_FLAG.sort() 69 | 70 | # Default to calling directory 71 | root_dir = '.' 72 | heading = True 73 | metadata = True 74 | minver = '' 75 | 76 | # Command line args 77 | parser = argparse.ArgumentParser(description="NIF Format XML Docs Generation") 78 | parser.add_argument('-p', '--path', help="The path where the doc folder will be generated.") 79 | parser.add_argument('-no-h1', '--no-heading', action='store_true', 80 | help="Whether to not generate the main

    heading. Used by NifSkope for built-in help.") 81 | parser.add_argument('-no-meta', '--no-metadata-columns', action='store_true', 82 | help="Whether to not generate the metadata attribute columns (arg, length, width, etc.)") 83 | parser.add_argument('-min-ver', '--minimum-version', 84 | help="Hides attributes below this version. Format 'XX.X.X.XX'") 85 | args = parser.parse_args() 86 | if args.path: 87 | root_dir = args.path 88 | if args.no_heading: 89 | heading = False 90 | if args.no_metadata_columns: 91 | metadata = False 92 | if args.minimum_version: 93 | minver = args.minimum_version 94 | 95 | # Logger 96 | logging.basicConfig(level=logging.INFO) 97 | logger = logging.getLogger('nifdoc') 98 | 99 | # Create the document generator 100 | doc = DocGenerator(root_dir + DOC_PATH, heading, metadata, version2number(minver)) 101 | logger.info("Generating NiObject Pages...") 102 | doc.gen_pages(NAMES_BLOCK, TYPES_BLOCK, tmpl.NIOBJECT if metadata else tmpl.NIOBJECT_NO_META) 103 | logger.info("Generating Struct Pages...") 104 | doc.gen_pages(NAMES_STRUCT, TYPES_STRUCT, tmpl.STRUCT if metadata else tmpl.STRUCT_NO_META) 105 | logger.info("Generating Basic Pages...") 106 | doc.gen_pages(NAMES_BASIC, TYPES_BASIC, tmpl.BASIC) 107 | logger.info("Generating Enum Pages...") 108 | enums = dict(TYPES_ENUM, **TYPES_FLAG) 109 | doc.gen_pages(sorted(enums), enums, tmpl.ENUM) 110 | 111 | logger.info("Generating Index Pages...") 112 | doc.gen_list_page('Basic Data Types', NAMES_BASIC, TYPES_BASIC, 'basic_list') 113 | doc.gen_list_page('NIF Object List', NAMES_BLOCK, TYPES_BLOCK, 'niobject_list') 114 | doc.gen_list_page('Struct Data Types', NAMES_STRUCT, TYPES_STRUCT, 'struct_list') 115 | doc.gen_list_page('Enum Data Types', sorted(enums), enums, 'enum_list') 116 | doc.gen_list_page('NIF File Format Versions', NAMES_VERSION, TYPES_VERSION, 'version_list', tmpl.VERSION_ROW, 'Versions') 117 | doc.gen_index() 118 | logger.info("Generation Complete.") 119 | 120 | 121 | class DocGenerator: 122 | """Methods for formatting and outputting the template strings with data from the XML""" 123 | 124 | def __init__(self, path, heading=True, metadata=True, min_ver=0): 125 | """Initialize generator""" 126 | self.doc_file = path + DOC_FILE 127 | self.main = tmpl.MAIN_H1 if heading else tmpl.MAIN_NO_H1 128 | self.attr_row = tmpl.ATTR if metadata else tmpl.ATTR_NO_META 129 | self.inherit = tmpl.INHERIT_ROW if metadata else tmpl.INHERIT_NO_META 130 | self.min_ver = min_ver 131 | self.blocks = dict(TYPES_BLOCK, **TYPES_STRUCT) 132 | install_dir = os.path.abspath(path) 133 | if not os.path.exists(install_dir): 134 | os.makedirs(install_dir) 135 | # Install CSS and ICO 136 | if os.path.dirname(CSS_PATH) != install_dir: 137 | copy2(CSS_PATH, install_dir) 138 | copy2(ICO_PATH, install_dir) 139 | 140 | # 141 | # Template Helper functions 142 | # 143 | def list_attributes(self, struct): 144 | """Create Attribute List""" 145 | attrs = '' 146 | count = 0 147 | for mem in struct.members: 148 | if self.min_ver and mem.until and mem.until < self.min_ver: 149 | continue 150 | attr_type = tmpl.TYPE_LINK.format(clean(mem.type), mem.type) 151 | if mem.template: 152 | attr_type += tmpl.TMPL_LINK.format(clean(mem.template), mem.template) 153 | content = { 154 | 'attr_name': mem.name, 155 | 'attr_type': attr_type, 156 | 'attr_arg': mem.arg, 157 | 'attr_length': mem.length.lhs, 158 | 'attr_width': mem.width.lhs, 159 | 'attr_cond': mem.cond, 160 | 'attr_desc': mem.description.replace('\n', '
    '), 161 | 'attr_from': mem.orig_since, 162 | 'attr_to': mem.orig_until, 163 | 'row': 'even' if count % 2 == 0 else 'odd' 164 | } 165 | count += 1 # Manually increment because of 'continue' on skipped versioned rows 166 | attrs += self.attr_row.format(**content) 167 | return attrs 168 | 169 | @staticmethod 170 | def list_tags(names, types, template): 171 | """List each tag with a description""" 172 | tag_list = '' 173 | for count, tname in enumerate(names): 174 | tag = types[tname] 175 | content = { 176 | 'list_name': tag.name, 177 | 'list_cname': clean(tag.name), 178 | 'list_desc': tag.description.replace('\n', '
    '), 179 | 'row': 'even' if count % 2 == 0 else 'odd' 180 | } 181 | tag_list += template.format(**content) 182 | return tag_list 183 | 184 | @staticmethod 185 | def list_choices(tag): 186 | """Create Choice List""" 187 | choice_list = '' 188 | for count, opt in enumerate(tag.options): 189 | content = { 190 | # Display bitflags as hex 191 | 'enum_number': opt.value if not hasattr(opt, 'bit') else '{0:#0{1}x}'.format(int(opt.value), 10), 192 | 'enum_name': opt.name, 193 | 'enum_desc': opt.description.replace('\n', '
    '), 194 | 'row': 'even' if count % 2 == 0 else 'odd' 195 | } 196 | choice_list += tmpl.ENUM_ROW.format(**content) 197 | return choice_list 198 | 199 | @staticmethod 200 | def list_child_blocks(block): 201 | """Create Child Block list""" 202 | return ''.join(tmpl.LI_LINK.format(clean(n), n) for n in NAMES_BLOCK if TYPES_BLOCK[n].inherit == block) 203 | 204 | def member_of(self, name): 205 | """Create Member Of list""" 206 | found = '' 207 | for b_name in NAMES_BLOCK + NAMES_STRUCT: 208 | for bmem in self.blocks[b_name].members: 209 | if bmem.type == name: 210 | found += tmpl.LI_LINK.format(clean(b_name), b_name) 211 | break 212 | return found 213 | 214 | def list_ancestor_attributes(self, block): 215 | """Create list of attributes for all ancestors""" 216 | attr_list = '' 217 | for ancestor in reversed(block.ancestors()): 218 | content = {'inherit': ancestor.name, 'cinherit': clean(ancestor.name)} 219 | attr_list += self.inherit.format(**content) + self.list_attributes(ancestor) 220 | return attr_list 221 | 222 | def list_object_tree(self, root): 223 | """Builds a hierarchical unordered list for a specified ancestor root.""" 224 | tree = '' 225 | # Get truncated description 226 | lines = root.description.splitlines(False) 227 | # Add a new list for this ancestor 228 | tree += tmpl.LI_LINK_DESC.format(clean(root.name), root.name, '' if not lines else lines[0]) 229 | # Create Child List 230 | children = [TYPES_BLOCK[n] for n in NAMES_BLOCK if TYPES_BLOCK[n].inherit == root] 231 | if children: 232 | tree += tmpl.UL_ITEM.format(''.join(self.list_object_tree(c) for c in children)) 233 | return tree 234 | 235 | # 236 | # Generation Functions 237 | # 238 | def gen_pages(self, names, types, template): 239 | """Generate Pages for XML Tag""" 240 | for count, name in enumerate(names): 241 | tag = types[name] 242 | contents = { 243 | 'name': tag.name, 244 | 'description': tag.description.replace('\n', '
    '), 245 | 'storage': '' if not isinstance(tag, Enum) else tag.storage, 246 | 'count': bool(tag.count == '1'), 247 | 'member_of': self.member_of(name) if not isinstance(tag, Block) else '', 248 | 'row': 'even' if count % 2 == 0 else 'odd' 249 | } 250 | if isinstance(tag, Block): 251 | contents['attributes'] = self.list_ancestor_attributes(tag) 252 | contents['parent_of'] = self.list_child_blocks(tag) 253 | elif isinstance(tag, Struct): 254 | contents['attributes'] = self.list_attributes(tag) 255 | elif isinstance(tag, Enum): 256 | contents['choices'] = self.list_choices(tag) 257 | 258 | page = {'title': tag.name, 'contents': template.format(**contents)} 259 | 260 | html = io.open(self.doc_file.format(clean(tag.name)), 'wt', 1, 'utf-8') 261 | html.write(self.main.format(**page)) 262 | html.close() 263 | 264 | def gen_list_page(self, title, names, types, page_name, row_tmpl=tmpl.LIST_ROW, header='Name'): 265 | """Generate List Page for XML Tag""" 266 | page = {'title': title} 267 | contents = { 268 | 'title': title, 269 | 'list_header': header, 270 | 'list': self.list_tags(names, types, row_tmpl) 271 | } 272 | if isinstance(types[names[0]], Block): 273 | page['contents'] = tmpl.NAV_LIST.format(**contents) 274 | else: 275 | page['contents'] = tmpl.LIST.format(**contents) 276 | 277 | html = io.open(self.doc_file.format(page_name), 'wt', 1, 'utf-8') 278 | html.write(self.main.format(**page)) 279 | html.close() 280 | 281 | def gen_index(self): 282 | """Generate index.html""" 283 | page = {'title': 'NIF Object Hierarchy'} 284 | contents = { 285 | 'title': page['title'], 286 | 'object_tree': self.list_object_tree(TYPES_BLOCK['NiObject']) 287 | } 288 | page['contents'] = tmpl.NAV_HIER.format(**contents) 289 | 290 | html = io.open(self.doc_file.format('index'), 'wt', 1, 'utf-8') 291 | html.write(self.main.format(**page)) 292 | html.close() 293 | 294 | 295 | if __name__ == "__main__": 296 | main() 297 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /tools/nifxml/nifxml.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | """ 3 | nifxml.py 4 | 5 | Parses nif.xml into dictionaries of classes grouped by XML tag type. 6 | 7 | This file is part of nifxml 8 | Copyright (c) 2017 NifTools 9 | 10 | This program is free software: you can redistribute it and/or modify 11 | it under the terms of the GNU General Public License as published by 12 | the Free Software Foundation, version 3. 13 | 14 | This program is distributed in the hope that it will be useful, but 15 | WITHOUT ANY WARRANTY; without even the implied warranty of 16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 | General Public License for more details. 18 | 19 | You should have received a copy of the GNU General Public License 20 | along with this program. If not, see . 21 | 22 | This file incorporates work covered by the following copyright and permission notice: 23 | Copyright (c) 2005, NIF File Format Library and Tools. 24 | All rights reserved. 25 | 26 | Redistribution and use in source and binary forms, with or without 27 | modification, are permitted provided that the following conditions 28 | are met: 29 | - Redistributions of source code must retain the above copyright 30 | notice, this list of conditions and the following disclaimer. 31 | - Redistributions in binary form must reproduce the above 32 | copyright notice, this list of conditions and the following 33 | disclaimer in the documentation and/or other materials provided 34 | with the distribution. 35 | - Neither the name of the NIF File Format Library and Tools 36 | project nor the names of its contributors may be used to endorse 37 | or promote products derived from this software without specific 38 | prior written permission. 39 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 40 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 41 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 42 | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 43 | COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 44 | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 45 | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 46 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 47 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 48 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 49 | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 50 | POSSIBILITY OF SUCH DAMAGE. 51 | """ 52 | 53 | from __future__ import unicode_literals 54 | 55 | from xml.dom.minidom import Node, parse 56 | 57 | import os 58 | import re 59 | import logging 60 | 61 | from .utility import export 62 | 63 | # 64 | # Globals 65 | # 66 | 67 | # The script will reject any versions older than this 68 | MIN_XML_VERSION = '0.9.1.0' 69 | 70 | XML_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)), '../../nif.xml') 71 | 72 | TYPES_NATIVE = {'TEMPLATE': 'T'} 73 | TYPES_BASIC = {} 74 | TYPES_ENUM = {} 75 | TYPES_FLAG = {} 76 | TYPES_STRUCT = {} 77 | TYPES_BLOCK = {} 78 | TYPES_VERSION = {} 79 | 80 | NAMES_BASIC = [] 81 | NAMES_STRUCT = [] 82 | NAMES_ENUM = [] 83 | NAMES_FLAG = [] 84 | NAMES_BLOCK = [] 85 | NAMES_VERSION = [] 86 | 87 | __all__ = ['TYPES_VERSION', 'TYPES_BASIC', 'TYPES_BLOCK', 'TYPES_STRUCT', 'TYPES_ENUM', 'TYPES_FLAG', 'TYPES_NATIVE', 88 | 'NAMES_VERSION', 'NAMES_BASIC', 'NAMES_BLOCK', 'NAMES_STRUCT', 'NAMES_ENUM', 'NAMES_FLAG'] 89 | 90 | 91 | @export 92 | def class_name(name_in): # type: (str) -> str 93 | """ 94 | Formats a valid C++ class name from the name format used in the XML. 95 | """ 96 | if name_in is None: 97 | return None 98 | try: 99 | return TYPES_NATIVE[name_in] 100 | except KeyError: 101 | return name_in.replace(' ', '_').replace(":", "_") 102 | 103 | if name_in is None: 104 | return None 105 | 106 | try: 107 | return TYPES_NATIVE[name_in] 108 | except KeyError: 109 | pass 110 | 111 | if name_in == 'TEMPLATE': 112 | return 'T' 113 | name_out = '' 114 | for i, char in enumerate(name_in): 115 | if char.isupper(): 116 | if i > 0: 117 | name_out += '_' 118 | name_out += char.lower() 119 | elif char.islower() or char.isdigit(): 120 | name_out += char 121 | else: 122 | name_out += '_' 123 | return name_out 124 | 125 | 126 | @export 127 | def define_name(name_in): # type: (str) -> str 128 | """ 129 | Formats an all-uppercase version of the name for use in C++ defines. 130 | """ 131 | name_out = '' 132 | for i, char in enumerate(name_in): 133 | if char.isupper(): 134 | if i > 0: 135 | name_out += '_' 136 | name_out += char 137 | else: 138 | name_out += char 139 | elif char.islower() or char.isdigit(): 140 | name_out += char.upper() 141 | else: 142 | name_out += '_' 143 | return name_out 144 | 145 | 146 | @export 147 | def member_name(name_in): # type: (str) -> str 148 | """ 149 | Formats a version of the name for use as a C++ member variable. 150 | """ 151 | if name_in is None or name_in == 'ARG': 152 | return name_in 153 | name_out = '' 154 | lower = True 155 | for char in name_in: 156 | if char == ' ': 157 | lower = False 158 | elif char.isalnum(): 159 | if lower: 160 | name_out += char.lower() 161 | else: 162 | name_out += char.upper() 163 | lower = True 164 | elif char == '\\': # arg member access operator 165 | name_out += '.' 166 | else: 167 | name_out += '_' 168 | lower = True 169 | return name_out 170 | 171 | 172 | @export 173 | def version2number(s): # type: (str) -> int 174 | """ 175 | Translates a legible NIF version number to the packed-byte numeric representation. 176 | For example, "10.0.1.0" is translated to 0x0A000100. 177 | """ 178 | if not s: 179 | return None 180 | 181 | numbers = s.split('.') 182 | if len(numbers) > 4: 183 | assert False 184 | return int(s) 185 | 186 | if len(numbers) == 2: 187 | version = 0 188 | version += int(numbers[0]) << (3 * 8) 189 | if len(numbers[1]) >= 1: 190 | version += int(numbers[1][0]) << (2 * 8) 191 | if len(numbers[1]) >= 2: 192 | version += int(numbers[1][1]) << (1 * 8) 193 | if len(numbers[1]) >= 3: 194 | version += int(numbers[1][2:]) 195 | return version 196 | else: 197 | version = 0 198 | for i, ver in enumerate(numbers): 199 | version += int(ver) << ((3 - i) * 8) 200 | return version 201 | 202 | 203 | @export 204 | def scanBrackets(expr_str, from_index=0): # type: (str, int) -> Tuple[int, int] 205 | """Looks for matching brackets. 206 | 207 | >>> scanBrackets('abcde') 208 | (-1, -1) 209 | >>> scanBrackets('()') 210 | (0, 1) 211 | >>> scanBrackets('(abc(def))g') 212 | (0, 9) 213 | >>> s = ' (abc(dd efy 442))xxg' 214 | >>> startpos, endpos = scanBrackets(s) 215 | >>> print s[startpos+1:endpos] 216 | abc(dd efy 442) 217 | """ 218 | startpos = -1 219 | endpos = -1 220 | scandepth = 0 221 | for scanpos in range(from_index, len(expr_str)): 222 | scanchar = expr_str[scanpos] 223 | if scanchar == "(": 224 | if startpos == -1: 225 | startpos = scanpos 226 | scandepth += 1 227 | elif scanchar == ")": 228 | scandepth -= 1 229 | if scandepth == 0: 230 | endpos = scanpos 231 | break 232 | else: 233 | if startpos != -1 or endpos != -1: 234 | raise ValueError("expression syntax error (non-matching brackets?)") 235 | return (startpos, endpos) 236 | 237 | 238 | class Expression: 239 | """This class represents an expression. 240 | 241 | >>> class A(object): 242 | ... x = False 243 | ... y = True 244 | >>> a = A() 245 | >>> e = Expression('x || y') 246 | >>> e.eval(a) 247 | 1 248 | >>> Expression('99 & 15').eval(a) 249 | 3 250 | >>> bool(Expression('(99&15)&&y').eval(a)) 251 | True 252 | >>> a.hello_world = False 253 | >>> def nameFilter(s): 254 | ... return 'hello_' + s.lower() 255 | >>> bool(Expression('(99 &15) &&WoRlD', name_filter = nameFilter).eval(a)) 256 | False 257 | >>> Expression('c && d').eval(a) 258 | Traceback (most recent call last): 259 | ... 260 | AttributeError: 'A' object has no attribute 'c' 261 | >>> bool(Expression('1 == 1').eval()) 262 | True 263 | >>> bool(Expression('1 != 1').eval()) 264 | False 265 | """ 266 | operators = ['==', '!=', '>=', '<=', '&&', '||', '&', '|', '-', '+', '>', '<', '/', '*'] 267 | 268 | def __init__(self, expr_str, name_filter=None): 269 | self._code = expr_str 270 | left, self._op, right = self._partition(expr_str) 271 | self._left = self._parse(left, name_filter) 272 | if right: 273 | self._right = self._parse(right, name_filter) 274 | else: 275 | self._right = '' 276 | 277 | def eval(self, data=None): 278 | """Evaluate the expression to an integer.""" 279 | 280 | if isinstance(self._left, Expression): 281 | left = self._left.eval(data) 282 | elif isinstance(self._left, str): 283 | left = getattr(data, self._left) if self._left != '""' else "" 284 | else: 285 | assert isinstance(self._left, int) # debug 286 | left = self._left 287 | 288 | if not self._op: 289 | return left 290 | 291 | if isinstance(self._right, Expression): 292 | right = self._right.eval(data) 293 | elif isinstance(self._right, str): 294 | right = getattr(data, self._right) if self._right != '""' else "" 295 | else: 296 | assert isinstance(self._right, int) # debug 297 | right = self._right 298 | 299 | if self._op == '==': 300 | return int(left == right) 301 | elif self._op == '!=': 302 | return int(left != right) 303 | elif self._op == '>=': 304 | return int(left >= right) 305 | elif self._op == '<=': 306 | return int(left <= right) 307 | elif self._op == '&&': 308 | return int(left and right) 309 | elif self._op == '||': 310 | return int(left or right) 311 | elif self._op == '&': 312 | return left & right 313 | elif self._op == '|': 314 | return left | right 315 | elif self._op == '-': 316 | return left - right 317 | elif self._op == '+': 318 | return left + right 319 | elif self._op == '/': 320 | return left / right 321 | elif self._op == '*': 322 | return left * right 323 | elif self._op == '!': 324 | return not left 325 | else: 326 | raise NotImplementedError("expression syntax error: operator '" + self._op + "' not implemented") 327 | 328 | def __str__(self): # type: () -> str 329 | """Reconstruct the expression to a string.""" 330 | 331 | left = str(self._left) 332 | if not self._op: 333 | return left 334 | right = str(self._right) 335 | return left + ' ' + self._op + ' ' + right 336 | 337 | def encode(self, encoding): # type: (str) -> str 338 | """ 339 | To allow encode() to be called on an Expression directly as if it were a string 340 | (For Python 2/3 cross-compatibility.) 341 | """ 342 | return self.__str__().encode(encoding) 343 | 344 | @classmethod 345 | def _parse(cls, expr_str, name_filter=None): # type: (str, Callable[[str], str]) -> str 346 | """Returns an Expression, string, or int, depending on the 347 | contents of .""" 348 | # brackets or operators => expression 349 | if ("(" in expr_str) or (")" in expr_str): 350 | return Expression(expr_str, name_filter) 351 | for op in cls.operators: 352 | if expr_str.find(op) != -1: 353 | return Expression(expr_str, name_filter) 354 | 355 | mver = re.compile("[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+") 356 | iver = re.compile("[0-9]+") 357 | 358 | # try to convert it to an integer 359 | try: 360 | if mver.match(expr_str): 361 | return "0x%08X" % (version2number(expr_str)) 362 | elif iver.match(expr_str): 363 | return str(int(expr_str)) 364 | except ValueError: 365 | pass 366 | 367 | # failed, so return the string, passed through the name filter 368 | return name_filter(expr_str) if name_filter else expr_str 369 | 370 | @classmethod 371 | def _partition(cls, expr_str): 372 | """Partitions expr_str. See examples below. 373 | 374 | >>> Expression._partition('abc || efg') 375 | ('abc', '||', 'efg') 376 | >>> Expression._partition('abc||efg') 377 | ('abc', '||', 'efg') 378 | >>> Expression._partition('abcdefg') 379 | ('abcdefg', '', '') 380 | >>> Expression._partition(' abcdefg ') 381 | ('abcdefg', '', '') 382 | >>> Expression._partition(' (a | b) & c ') 383 | ('a | b', '&', 'c') 384 | >>> Expression._partition('(a | b)!=(b&c)') 385 | ('a | b', '!=', 'b&c') 386 | >>> Expression._partition('(a== b) &&(( b!=c)||d )') 387 | ('a== b', '&&', '( b!=c)||d') 388 | """ 389 | # check for unary operators 390 | if expr_str.strip().startswith('!'): 391 | return expr_str.lstrip(' !'), '!', None 392 | lenstr = len(expr_str) 393 | # check if the left hand side starts with brackets 394 | # and if so, find the position of the starting bracket and the ending 395 | # bracket 396 | left_startpos, left_endpos = cls._scan_brackets(expr_str) 397 | if left_startpos >= 0: 398 | # yes, it is a bracketed expression 399 | # so remove brackets and whitespace, 400 | # and let that be the left hand side 401 | left_str = expr_str[left_startpos + 1:left_endpos].strip() 402 | 403 | # the next token should be the operator 404 | # find the position where the operator should start 405 | op_start_pos = left_endpos + 1 406 | while op_start_pos < lenstr and expr_str[op_start_pos] == " ": 407 | op_start_pos += 1 408 | if op_start_pos < lenstr: 409 | # to avoid confusion between && and &, and || and |, 410 | # let's first scan for operators of two characters 411 | # and then for operators of one character 412 | for op_end_pos in range(op_start_pos + 1, op_start_pos - 1, -1): 413 | op_str = expr_str[op_start_pos:op_end_pos + 1] 414 | if op_str in cls.operators: 415 | break 416 | else: 417 | raise ValueError("expression syntax error: expected operator at '%s'" % expr_str[op_start_pos:]) 418 | else: 419 | return cls._partition(left_str) 420 | else: 421 | # it's not... so we need to scan for the first operator 422 | for op_start_pos, ch in enumerate(expr_str): 423 | if ch == ' ': 424 | continue 425 | if ch == '(' or ch == ')': 426 | raise ValueError("expression syntax error: expected operator before '%s'" % expr_str[op_start_pos:]) 427 | # to avoid confusion between && and &, and || and |, 428 | # let's first scan for operators of two characters 429 | for op_end_pos in range(op_start_pos + 1, op_start_pos - 1, -1): 430 | op_str = expr_str[op_start_pos:op_end_pos + 1] 431 | if op_str in cls.operators: 432 | break 433 | else: 434 | continue 435 | break 436 | else: 437 | # no operator found, so we are done 438 | left_str = expr_str.strip() 439 | op_str = '' 440 | right_str = '' 441 | return left_str, op_str, right_str 442 | 443 | # operator found! now get the left hand side 444 | left_str = expr_str[:op_start_pos].strip() 445 | 446 | return left_str, op_str, expr_str[op_end_pos + 1:].strip() 447 | 448 | @staticmethod 449 | def _scan_brackets(expr_str, from_index=0): 450 | """Looks for matching brackets. 451 | 452 | >>> Expression._scan_brackets('abcde') 453 | (-1, -1) 454 | >>> Expression._scan_brackets('()') 455 | (0, 1) 456 | >>> Expression._scan_brackets('(abc(def))g') 457 | (0, 9) 458 | >>> s = ' (abc(dd efy 442))xxg' 459 | >>> startpos, endpos = Expression._scan_brackets(s) 460 | >>> print s[startpos+1:endpos] 461 | abc(dd efy 442) 462 | """ 463 | startpos = -1 464 | endpos = -1 465 | scandepth = 0 466 | for scanpos in range(from_index, len(expr_str)): 467 | scanchar = expr_str[scanpos] 468 | if scanchar == "(": 469 | if startpos == -1: 470 | startpos = scanpos 471 | scandepth += 1 472 | elif scanchar == ")": 473 | scandepth -= 1 474 | if scandepth == 0: 475 | endpos = scanpos 476 | break 477 | else: 478 | if startpos != -1 or endpos != -1: 479 | raise ValueError("expression syntax error (non-matching brackets?)") 480 | return (startpos, endpos) 481 | 482 | def code(self, prefix='', brackets=True, name_filter=None): # type: (str, bool, Callable[[str], str]) -> str 483 | """Format an expression as a string.""" 484 | lbracket = "(" if brackets else "" 485 | rbracket = ")" if brackets else "" 486 | if not self._op: 487 | if not self.lhs: 488 | return '' 489 | if isinstance(self.lhs, int): 490 | return self.lhs 491 | elif self.lhs in TYPES_BLOCK: 492 | return 'IsDerivedType(%s::TYPE)' % self.lhs 493 | else: 494 | return prefix + (name_filter(self.lhs) if name_filter else self.lhs) 495 | elif self._op == '!': 496 | lhs = self.lhs 497 | if isinstance(lhs, Expression): 498 | lhs = lhs.code(prefix, True, name_filter) 499 | elif lhs in TYPES_BLOCK: 500 | lhs = 'IsDerivedType(%s::TYPE)' % lhs 501 | elif lhs and not lhs.isdigit() and not lhs.startswith('0x'): 502 | lhs = prefix + (name_filter(lhs) if name_filter else lhs) 503 | return '%s%s%s%s' % (lbracket, self._op, lhs, rbracket) 504 | else: 505 | lhs = self.lhs 506 | if isinstance(lhs, Expression): 507 | lhs = lhs.code(prefix, True, name_filter) 508 | elif lhs in TYPES_BLOCK: 509 | lhs = 'IsDerivedType(%s::TYPE)' % lhs 510 | elif lhs and not lhs.isdigit() and not lhs.startswith('0x'): 511 | lhs = prefix + (name_filter(lhs) if name_filter else lhs) 512 | 513 | rhs = self.rhs 514 | if isinstance(rhs, Expression): 515 | rhs = rhs.code(prefix, True, name_filter) 516 | elif rhs in TYPES_BLOCK: 517 | rhs = 'IsDerivedType(%s::TYPE)' % rhs 518 | elif rhs and not rhs.isdigit() and not rhs.startswith('0x'): 519 | rhs = prefix + (name_filter(rhs) if name_filter else rhs) 520 | return '%s%s %s %s%s' % (lbracket, lhs, self._op, rhs, rbracket) 521 | 522 | def get_terminals(self): 523 | """Return all terminal names (without operators or brackets).""" 524 | if isinstance(self.lhs, Expression): 525 | for terminal in self.lhs.get_terminals(): 526 | yield terminal 527 | elif self.lhs: 528 | yield self.lhs 529 | if isinstance(self.rhs, Expression): 530 | for terminal in self.rhs.get_terminals(): 531 | yield terminal 532 | elif self.rhs: 533 | yield self.rhs 534 | 535 | def __getattr__(self, name): 536 | if name == 'lhs': 537 | return getattr(self, '_left') 538 | if name == 'rhs': 539 | return getattr(self, '_right') 540 | if name == 'op': 541 | return getattr(self, '_op') 542 | return object.__getattribute__(self, name) 543 | 544 | def isdigit(self): 545 | """ducktyping: pretend we're also a string with isdigit() method""" 546 | return False 547 | 548 | 549 | class Expr(Expression): 550 | """ 551 | Represents a mathmatical expression? 552 | @ivar lhs: The left hand side of the expression? 553 | @ivar clhs: The C++ formatted version of the left hand side of the expression? 554 | @ivar op: The operator used in the expression. ==, &&, !=, etc. 555 | @ivar rhs: The right hand side of the expression? 556 | """ 557 | 558 | def __init__(self, n, name_filter=None): 559 | """ 560 | This constructor takes the expression in the form of a string and tokenizes it into left-hand side, 561 | operator, right hand side, and something called clhs. 562 | @param n: The expression to tokenize. 563 | @type n: string 564 | """ 565 | Expression.__init__(self, n, name_filter) 566 | 567 | def code(self, prefix='', brackets=True, name_filter=None): 568 | if not name_filter: 569 | name_filter = member_name 570 | return Expression.code(self, prefix, brackets, name_filter) 571 | 572 | 573 | class Option: 574 | """ 575 | This class represents an option in an option list. 576 | @ivar value: The C++ value of option variable. Comes from the "value" attribute of the . 579 | @ivar cname: The name of this member for use in C++. 580 | """ 581 | 582 | def __init__(self, element): 583 | """ 584 | This constructor converts an XML