nifxml 0.9 specification sync

.gitignore

@@ -0,0 +1,14 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Generated html
+*.html
+
+# VS Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

__init__.py

@@ -1 +1,7 @@
 __all__ = ["nifxml"]
+
+from .nifxml import parse_xml
+from .nifxml import Member, Version, Basic, Compound, Block, Enum, Flag
+from .nifxml import TYPES_VERSION, TYPES_BASIC, TYPES_BLOCK, TYPES_COMPOUND, TYPES_ENUM, TYPES_FLAG, TYPES_NATIVE
+from .nifxml import NAMES_VERSION, NAMES_BASIC, NAMES_BLOCK, NAMES_COMPOUND, NAMES_ENUM, NAMES_FLAG
+from .nifxml import class_name, define_name, member_name, version2number, scanBrackets

doc/docsys.css → doc/nifdoc.css

@@ -2,26 +2,31 @@ hr        { border: 1px; color: black; background: black; height: 1px; }
 body      { font-family: Verdana, Arial, Helvetica, sans-serif; }
 p, td, th, div, pre, li { color: black; font-size: 10pt; }
 td        { vertical-align: text-top; }
-a         { color: #006699; text-decoration: none;}
-a:link    { color: #006699; text-decoration: none;}
-a:visited { color: #006699; text-decoration: none;}
+a         { color: #2087bb; text-decoration: none;}
+a:link    { color: #2087bb; text-decoration: none;}
+a:visited { color: #2087bb; text-decoration: none;}
 a:active  { text-decoration: none;}
 a:hover   { color: #DD6900; text-decoration: underline;}
 
+table         { width: 100%; }
 th            { font-weight: bold;  color: black; background: #D3DCE3}
 h1            { text-align: center; color: black; background: #FF6600; }
 h2            { text-align: center; color: black; background: #FFCC33; }
 h3            { text-align: left;   color: black; background: #FFCC66; }
-a:link        { text-decoration: none;      color: #006699; background: transparent; }
-a:visited     { text-decoration: none;      color: #006699; background: transparent; }
+a:link        { text-decoration: none;      color: #2087bb; background: transparent; }
+a:visited     { text-decoration: none;      color: #2087bb; background: transparent; }
 a:hover       { text-decoration: underline; color: #DD6900; background: transparent; }
 a:link.nav    { color: #000000; background: transparent; }
 a:visited.nav { color: #000000; background: transparent; }
 a:hover.nav   { color: #FF0000; background: transparent; }
 .nav          { color: #000000; background: transparent; }
-tr.reg0       { background: #CCCCCC; color: black; }
-tr.reg1       { background: #DDDDDD; color: black; }
-tr.inact0     { background: #CCAAAA; color: black; }
-tr.inact1     { background: #DDBBBB; color: black; }
-tr.extrnl     { background: #AADDAA; color: black; }
+tr            { background: #DDDDDD; color: black; }
+tr.odd        { background: #DDDDDD; color: black; }
+tr.even       { background: #EEEEEE; color: black; }
 
+td.aname { white-space: nowrap; }
+td.atype { white-space: nowrap; }
+td.aarg  { font-size: small; font-family: 'Courier New', Courier, monospace; }
+td.aarr1 { font-size: small; font-family: 'Courier New', Courier, monospace; }
+td.aarr2 { font-size: small; font-family: 'Courier New', Courier, monospace; }
+td.acond { font-size: small; font-family: 'Courier New', Courier, monospace; }

doc/nifdoc_tmpl.py

@@ -0,0 +1,207 @@
+#!/usr/bin/python
+"""
+ This file is part of nifxml <https://github.com/niftools/nifxml>
+ Copyright (c) 2017 NifTools
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, version 3.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+"""
+from __future__ import unicode_literals
+
+UL_ITEM = '<ul>\n{0}</ul>\n'
+LI_LINK = '\t<li><a href="{0}.html">{1}</a></li>\n'
+LI_LINK_DESC = '<li><a href="{0}.html"><b>{1}</b></a> | {2}</li>\n'
+TYPE_LINK = '<a href="{0}.html"><b>{1}</b></a>'
+TMPL_LINK = '&lt;<a href="{0}.html">{1}</a>&gt;'
+
+MAIN_BEG = """<!doctype html>
+<html lang="en">
+<head>
+\t<title>NIF File Format Documentation - {title}</title>
+\t<link rel="stylesheet" href="nifdoc.css" type="text/css" />
+\t<link rel="icon" href="favicon.ico" type="image/x-icon" />
+</head>
+<body>"""
+MAIN_END = """
+\t<p align="center"><a href="index.html">NIF Objects</a> | <a href="compound_list.html">Compound Types</a> 
+\t| <a href="enum_list.html">Enum Types</a> | <a href="basic_list.html">Basic Types</a> | <a href="version_list.html">File Versions</a></p>
+\t{contents}
+</body>
+</html>"""
+
+# Main HTML template with and without H1 heading
+MAIN_H1 = MAIN_BEG + '<center><h1>NIF File Format Documentation</h1></center>' + MAIN_END
+MAIN_NO_H1 = MAIN_BEG + MAIN_END
+
+# Attribute row with metadata
+ATTR = """
+<tr class="{row}">
+\t<td class="aname">{attr_name}</td>
+\t<td class="atype">{attr_type}</td>
+\t<td class="aarg">{attr_arg}</td>
+\t<td class="aarr1">{attr_arr1}</td>
+\t<td class="aarr2">{attr_arr2}</td>
+\t<td class="acond">{attr_cond}</td>
+\t<td class="adesc">{attr_desc}</td>
+\t<td class="afrom">{attr_from}</td>
+\t<td class="ato">{attr_to}</td>
+</tr>
+"""
+
+# Attribute row without metadata
+ATTR_NO_META = """
+<tr class="{row}">
+\t<td class="aname">{attr_name}</td>
+\t<td class="atype">{attr_type}</td>
+\t<td class="adesc">{attr_desc}</td>
+</tr>
+"""
+
+# List for Found In
+FOUND_IN = """
+<h3>Found In</h3>
+<ul>
+{member_of}
+</ul>
+"""
+
+# List for Parent Of
+PARENT_OF = """
+<h3>Parent Of</h3>
+<ul>
+{parent_of}
+</ul>"""
+
+# Basic layout
+BASIC = """
+<center><h2>{name}</h2></center>
+{description}
+
+<h3>Can Be Used As Array Size</h3>
+<p>{count}</p>
+""" + FOUND_IN
+
+# Block with metadata columns
+BLOCK = """
+<center><h2>{name}</h2></center>
+{description}
+<h3>Attributes</h3>
+<table>
+\t<tr>
+\t\t<th>Name</th>
+\t\t<th>Type</th>
+\t\t<th>Arg</th>
+\t\t<th>Arr1</th>
+\t\t<th>Arr2</th>
+\t\t<th>Cond</th>
+\t\t<th>Description</th>
+\t\t<th>From</th><th>To</th>
+\t</tr>
+\t{attributes}
+</table>
+"""
+
+# Block without metadata columns
+BLOCK_NM = """
+<center><h2>{name}</h2></center>
+{description}
+<h3>Attributes</h3>
+<table>
+\t<tr>
+\t\t<th>Name</th>
+\t\t<th>Type</th>
+\t\t<th>Description</th>
+\t</tr>
+\t{attributes}
+</table>
+"""
+
+# Compound and NiObject with and without metadata columns
+COMPOUND = BLOCK + FOUND_IN
+NIOBJECT = BLOCK + PARENT_OF
+COMPOUND_NO_META = BLOCK_NM + FOUND_IN
+NIOBJECT_NO_META = BLOCK_NM + PARENT_OF
+
+# Object tree for index.html
+HIERARCHY = """
+<ul>{object_tree}</ul>"""
+
+# Object list for *_list.html
+LIST = """
+<table>
+\t<tr>
+\t\t<th>{list_header}</th>
+\t\t<th>Description</th>
+\t</tr>
+{list}
+</table>"""
+
+# Navbar
+NAV = """<p align="center"><a href="index.html">Hierarchy</a> | <a href="niobject_list.html">List</a></p>
+<center><h2>{title}</h2></center>
+"""
+
+# Nav plus contents
+NAV_LIST = NAV + LIST
+NAV_HIER = NAV + HIERARCHY
+
+# Enum layout
+ENUM = """
+<h2>{name}</h2>
+{description}
+
+<h3>Choices</h3>
+<table>
+\t<tr class="{row}">
+\t\t<th>Number</th>
+\t\t<th>Name</th>
+\t\t<th>Description</th>
+\t</tr>
+\t{choices}
+</table>
+
+<h3>Storage Type</h3>
+<a href ="{storage}.html">{storage}</a>
+""" + FOUND_IN
+
+ENUM_ROW = """
+<tr class="{row}">
+\t<td>{enum_number}</td>
+\t<td><b>{enum_name}</b></td>
+\t<td>{enum_desc}</td>
+</tr>
+"""
+
+INHERIT_ROW = """
+<tr>
+\t<th align="left" style="text-align:left;" colspan="9">From <a href ="{cinherit}.html">{inherit}</a></th>
+</tr>
+"""
+
+INHERIT_NO_META = """
+<tr>
+\t<th align="left" style="text-align:left;" colspan="3">From <a href ="{cinherit}.html">{inherit}</a></th>
+</tr>
+"""
+
+LIST_ROW = """
+<tr class="{row}">
+\t<td><b><a href="{list_cname}.html">{list_name}</a></b></td>
+\t<td>{list_desc}</td>
+</tr>"""
+
+VERSION_ROW = """
+<tr class="{row}">
+\t<td><b>{list_name}</a></b></td>
+\t<td>{list_desc}</td>
+</tr>
+"""