gobject-introspection 2.2.4-x64-mingw32

data/vendor/local/lib/gobject-introspection/giscanner/docmain.py

@@ -0,0 +1,72 @@
+# -*- Mode: Python -*-
+# GObject-Introspection - a framework for introspecting GObject libraries
+# Copyright (C) 2008-2011 Johan Dahlin
+#
+# 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; either version 2
+# of the License, or (at your option) any later version.
+#
+# 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, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301, USA.
+#
+
+import os
+import optparse
+
+from .docwriter import DocWriter
+from .sectionparser import generate_sections_file, write_sections_file
+from .transformer import Transformer
+
+
+def doc_main(args):
+    parser = optparse.OptionParser('%prog [options] GIR-file')
+
+    parser.add_option("-o", "--output",
+                      action="store", dest="output",
+                      help="Directory to write output to")
+    parser.add_option("-l", "--language",
+                      action="store", dest="language",
+                      default="c",
+                      help="Output language")
+    parser.add_option("", "--add-include-path",
+                      action="append", dest="include_paths", default=[],
+                      help="include paths for other GIR files")
+    parser.add_option("", "--write-sections-file",
+                      action="store_true", dest="write_sections",
+                      help="Generate and write out a sections file")
+
+    options, args = parser.parse_args(args)
+    if not options.output:
+        raise SystemExit("missing output parameter")
+
+    if len(args) < 2:
+        raise SystemExit("Need an input GIR filename")
+
+    if 'UNINSTALLED_INTROSPECTION_SRCDIR' in os.environ:
+        top_srcdir = os.environ['UNINSTALLED_INTROSPECTION_SRCDIR']
+        top_builddir = os.environ['UNINSTALLED_INTROSPECTION_BUILDDIR']
+        extra_include_dirs = [os.path.join(top_srcdir, 'gir'), top_builddir]
+    else:
+        extra_include_dirs = []
+    extra_include_dirs.extend(options.include_paths)
+    transformer = Transformer.parse_from_gir(args[1], extra_include_dirs)
+
+    if options.write_sections:
+        sections_file = generate_sections_file(transformer)
+
+        fp = open(options.output, 'w')
+        write_sections_file(fp, sections_file)
+        fp.close()
+    else:
+        writer = DocWriter(transformer, options.language)
+        writer.write(options.output)
+
+    return 0

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/callback.tmpl

@@ -0,0 +1,4 @@
+<%inherit file="./function.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+  </%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/class.tmpl

@@ -0,0 +1,2 @@
+<%! page_type="guide" %>\
+<%inherit file="/class.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/constructor.tmpl

@@ -0,0 +1 @@
+<%inherit file="./function.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/default.tmpl

@@ -0,0 +1 @@
+<%inherit file="/base.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/enum.tmpl

@@ -0,0 +1,2 @@
+<%! page_type="guide" %>\
+<%inherit file="/base.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/field.tmpl

@@ -0,0 +1 @@
+<%inherit file="/base.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/function.tmpl

@@ -0,0 +1,60 @@
+<%inherit file="/base.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+    <api:function>
+      <api:returns>
+        <api:type>${formatter.format_type(node.retval.type) | x}</api:type>
+      </api:returns>
+      <api:name>${formatter.format_function_name(node)}</api:name>
+% for arg in formatter.get_in_parameters(node):
+% if arg.type.ctype == '<varargs>':
+      <api:varargs/>
+% else:
+      <api:arg>
+        <api:type>${formatter.format_type(arg.type) | x}</api:type>
+        <api:name>${formatter.format_parameter_name(node, arg)}</api:name>
+      </api:arg>
+% endif
+% endfor
+    </api:function>
+</%block>
+<%block name="synopsis">
+  <synopsis><code mime="text/x-csrc">
+${node.retval.type.ctype} ${formatter.format_function_name(node)} (\
+% if not formatter.get_in_parameters(node):
+void\
+% else:
+% for ix, arg in enumerate(formatter.get_in_parameters(node)):
+% if ix != 0:
+${' ' * (len(formatter.format_type(node.retval.type)) + len(formatter.format_function_name(node)) + 3)}\
+% endif
+% if arg.type.ctype == '<varargs>':
+...\
+% else:
+${formatter.format_type(arg.type) | x} ${arg.argname}\
+% endif
+% if ix != len(formatter.get_in_parameters(node)) - 1:
+,
+% endif
+% endfor
+% endif
+);
+  </code></synopsis></%block>
+<%block name="details">
+% if formatter.get_in_parameters(node) or node.retval:
+<terms>
+% for arg in formatter.get_in_parameters(node):
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
+% endfor
+% if node.retval:
+<item>
+<title><code>Returns</code></title>
+${formatter.format(node, node.retval.doc)}
+</item>
+% endif
+</terms>
+% endif
+</%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/interface.tmpl

@@ -0,0 +1,2 @@
+<%! page_type="guide" %>\
+<%inherit file="/class.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/method.tmpl

@@ -0,0 +1 @@
+<%inherit file="./function.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/namespace.tmpl

@@ -0,0 +1 @@
+<%inherit file="/namespace.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/property.tmpl

@@ -0,0 +1,5 @@
+<%inherit file="/base.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+    <title type="link" role="topic">${node.name}</title>
+</%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/record.tmpl

@@ -0,0 +1 @@
+<%inherit file="/base.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/signal.tmpl

@@ -0,0 +1,5 @@
+<%inherit file="./function.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+    <title type="link" role="topic">${node.name}</title>
+</%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/C/vfunc.tmpl

@@ -0,0 +1,4 @@
+<%inherit file="./function.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+</%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/callback.tmpl

@@ -0,0 +1,27 @@
+<%inherit file="/base.tmpl"/>
+<%block name="synopsis">
+  <synopsis><code mime="text/x-gjs">
+function on${node.name}(\
+${', '.join('%s: %s' % (arg.argname, formatter.format_type(arg.type, True)) for arg in formatter.get_in_parameters(node))}\
+): ${formatter.format_out_parameters(node)} {
+}
+  </code></synopsis></%block>
+<%block name="details">
+% if formatter.has_any_parameters(node):
+<terms>
+% for arg in formatter.get_in_parameters(node):
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
+% endfor
+% for arg in formatter.get_out_parameters(node):
+<item>
+<title><code>${(arg.argname + ' (out)') if arg.direction == 'inout' else arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
+% endfor
+</terms>
+% endif
+</%block>
+

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/class.tmpl

@@ -0,0 +1,30 @@
+<%inherit file="/class.tmpl"/>
+<%block name="synopsis">
+  <synopsis>\
+% if node.namespace is not None:
+<code>
+const ${namespace.name} = imports.gi.${namespace.name};
+
+let ${formatter.to_lower_camel_case(node.name)} = new ${namespace.name}.${node.name}(\
+% if isinstance(node, (ast.Class, ast.Interface)):
+% if len(node.properties) > 0:
+{
+% for ix, property_ in enumerate(node.properties):
+% if (property_.construct or property_.construct_only) and property_.writable:
+    <link xref='${namespace.name}.${node.name}-${property_.name}'>${property_.name.replace('-', '_')}</link>: value,
+% endif
+% endfor
+}\
+% endif
+% else:
+${formatter.format_gboxed_constructor(node)}\
+% endif
+);
+  </code>\
+% else:
+  <p>
+    This structure is inside ${node.parent.namespace.name}.${node.parent.name}
+    and can only be used as a field of that.
+  </p>
+% endif
+</synopsis></%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/constructor.tmpl

@@ -0,0 +1 @@
+<%inherit file="./function.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/default.tmpl

@@ -0,0 +1 @@
+<%inherit file="/base.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/enum.tmpl

@@ -0,0 +1,21 @@
+<%! page_type="guide" %>
+<%inherit file="/base.tmpl"/>
+<%block name="details">
+% if node.members:
+<terms>
+% for member in node.members:
+<item>
+<title><code>${node.name}.${member.name.upper()}</code></title>
+${formatter.format(node, member.doc)}
+</item>
+% endfor
+</terms>
+% endif
+</%block>
+<%block name="links">\
+  <links type="topic" ui:expanded="true"
+         api:type="function" api:mime="${formatter.mime_type}"
+         groups="function" style="linklist">
+    <title>Functions</title>
+  </links>\
+</%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/field.tmpl

@@ -0,0 +1,9 @@
+<%inherit file="/base.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+    <title type="link" role="topic">${node.name}</title>
+</%block>
+<%block name="synopsis">
+  <synopsis><code mime="text/x-gjs">
+${node.parent.name}.${formatter.to_underscores(node)}: ${formatter.format_type(node.type, True)} (${formatter.format_property_flags(node)})
+  </code></synopsis></%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/function.tmpl

@@ -0,0 +1,47 @@
+<%inherit file="/base.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+    <api:function>
+      <api:returns>
+        <api:type>${formatter.format_type(node.retval.type) | x}</api:type>
+      </api:returns>
+      <api:name>${node.symbol}</api:name>
+% for arg in formatter.get_in_parameters(node):
+% if arg.type.ctype == '<varargs>':
+      <api:varargs/>
+% else:
+      <api:arg>
+        <api:type>${formatter.format_type(arg.type) | x}</api:type>
+        <api:name>${formatter.format_parameter_name(node, arg)}</api:name>
+      </api:arg>
+% endif
+% endfor
+    </api:function>
+</%block>
+<%block name="synopsis">
+  <synopsis><code mime="text/x-gjs">
+function \
+${node.name if node.shadows is None else node.shadows}(\
+${', '.join('%s: %s' % (arg.argname, formatter.format_type(arg.type, True)) for arg in formatter.get_in_parameters(node))}\
+): ${formatter.format_out_parameters(node)} {
+    // Gjs wrapper for ${node.symbol}()
+}
+  </code></synopsis></%block>
+<%block name="details">
+% if formatter.has_any_parameters(node):
+<terms>
+% for arg in formatter.get_in_parameters(node):
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
+% endfor
+% for arg in formatter.get_out_parameters(node):
+<item>
+<title><code>${(arg.argname + ' (out)') if arg.direction == 'inout' else arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
+% endfor
+</terms>
+% endif
+</%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/interface.tmpl

@@ -0,0 +1,17 @@
+<%inherit file="/class.tmpl"/>
+<%block name="synopsis">
+  <synopsis><code>
+const ${namespace.name} = imports.gi.${namespace.name};
+
+let ${formatter.to_underscores(node).lower()} = new ${namespace.name}.${node.name}(\
+% if len(node.properties) > 0:
+{
+% for ix, property_ in enumerate(node.properties):
+% if (property_.construct or property_.construct_only) and property_.writable:
+    <link xref='${namespace.name}.${node.name}-${property_.name}'>${property_.name.replace('-', '_')}</link>: value,
+% endif
+% endfor
+}\
+% endif
+);
+  </code></synopsis></%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/method.tmpl

@@ -0,0 +1 @@
+<%inherit file="./function.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/namespace.tmpl

@@ -0,0 +1,2 @@
+<%! page_type="guide" %>\
+<%inherit file="/namespace.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/property.tmpl

@@ -0,0 +1,9 @@
+<%inherit file="/base.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+    <title type="link" role="topic">${node.name}</title>
+</%block>
+<%block name="synopsis">
+  <synopsis><code mime="text/x-gjs">
+${node.parent.name}.${formatter.to_underscores(node)}: ${formatter.format_type(node.type, True)} (${formatter.format_property_flags(node)})
+  </code></synopsis></%block>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/record.tmpl

@@ -0,0 +1,2 @@
+<%! page_type="guide" %>\
+<%inherit file="/base.tmpl"/>

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/signal.tmpl

@@ -0,0 +1,38 @@
+<%inherit file="/base.tmpl"/>
+<%block name="info">
+    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
+    <title type="link" role="topic">${node.name}</title>
+</%block>
+<%block name="synopsis">
+  <synopsis><code mime="text/x-gjs">
+connect('${node.name}', function (${formatter.to_lower_camel_case(node.parent.name)}, \
+% for arg in formatter.get_in_parameters(node):
+% if arg.type.target_fundamental != 'none':
+${arg.argname}: ${formatter.format_type(arg.type, True)}, \
+% endif
+% endfor
+): ${formatter.format_type(node.retval.type, True)});
+  </code></synopsis></%block>
+<%block name="details">
+<terms>
+<item>
+<title><code>${formatter.to_lower_camel_case(node.parent.name)}</code></title>
+<p>instance of ${formatter.format_xref(node.parent)} that is emitting the signal</p>
+</item>
+% for arg in formatter.get_in_parameters(node):
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
+% endfor
+% if node.retval and \
+     node.retval.type.ctype != 'void' and \
+     node.retval.type.ctype is not None:
+<item>
+<title><code>Returns</code></title>
+${formatter.format(node, node.retval.doc)}
+</item>
+% endif
+</terms>
+</%block>
+

data/vendor/local/lib/gobject-introspection/giscanner/doctemplates/Gjs/vfunc.tmpl

@@ -0,0 +1,27 @@
+<%inherit file="/base.tmpl"/>
+<%block name="synopsis">
+  <synopsis><code mime="text/x-gjs">
+function vfunc_${node.name}(\
+${', '.join('%s: %s' % (arg.argname, formatter.format_type(arg.type, True)) for arg in formatter.get_in_parameters(node))}\
+): ${formatter.format_out_parameters(node)} {
+}
+  </code></synopsis></%block>
+<%block name="details">
+% if formatter.get_in_parameters(node) or node.retval:
+<terms>
+% for arg in formatter.get_in_parameters(node):
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
+% endfor
+% if node.retval and node.retval.type.ctype != 'void':
+<item>
+<title><code>Returns</code></title>
+${formatter.format(node, node.retval.doc)}
+</item>
+% endif
+</terms>
+% endif
+</%block>
+