From 971d1f98053eec324756429a7966aab2279abd87 Mon Sep 17 00:00:00 2001
From: Colin Walters
Date: Sat, 23 Feb 2013 11:55:56 -0500
Subject: doctool: Use builtin namespace walker
Rather than hand-rolling our own. This ensures we traverse all nodes.
https://bugzilla.gnome.org/show_bug.cgi?id=694593
---
giscanner/docwriter.py | 53 +++++++++++++---------
.../Regress.AnnotationObject.watch.page | 2 +-
.../Regress.FooBUnion.get_contained_type.page | 48 ++++++++++++++++++++
.../Regress.FooBUnion.new.page | 40 ++++++++++++++++
.../Regress.FooEnumType.method.page | 48 ++++++++++++++++++++
.../Regress.FooEnumType.returnv.page | 48 ++++++++++++++++++++
.../Regress.FooError.quark.page | 40 ++++++++++++++++
.../Regress.FooInterfaceIface.do_regress_foo.page | 25 ++++++++++
.../Regress.FooObjectClass.read_fn.page | 25 ++++++++++
.../Regress.FooObjectClass.virtual_method.page | 25 ++++++++++
...Regress.FooSubInterfaceIface.destroy_event.page | 25 ++++++++++
.../Regress.FooSubInterfaceIface.do_bar.page | 25 ++++++++++
.../Regress.FooSubInterfaceIface.do_baz.page | 25 ++++++++++
.../Regress.TestABCError.quark.page | 40 ++++++++++++++++
.../Regress.TestEnum.param.page | 48 ++++++++++++++++++++
.../Regress.TestError.quark.page | 40 ++++++++++++++++
.../Regress.TestObjClass._regress_reserved1.page | 25 ++++++++++
.../Regress.TestObjClass._regress_reserved2.page | 25 ++++++++++
.../Regress.TestObjClass.allow_none_vfunc.page | 25 ++++++++++
.../Regress.TestObjClass.matrix.page | 25 ++++++++++
.../Regress.TestOtherError.quark.page | 40 ++++++++++++++++
21 files changed, 674 insertions(+), 23 deletions(-)
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.get_contained_type.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.new.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.method.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.returnv.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooError.quark.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooInterfaceIface.do_regress_foo.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.read_fn.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.virtual_method.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.destroy_event.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_bar.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_baz.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestABCError.quark.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestEnum.param.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestError.quark.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved1.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved2.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.allow_none_vfunc.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.matrix.page
create mode 100644 tests/scanner/Regress-1.0-C-expected/Regress.TestOtherError.quark.page
diff --git a/giscanner/docwriter.py b/giscanner/docwriter.py
index e962b914..7924b2d3 100644
--- a/giscanner/docwriter.py
+++ b/giscanner/docwriter.py
@@ -38,10 +38,18 @@ def make_page_id(node, recursive=False):
else:
return 'index'
+ if hasattr(node, '_chain') and node._chain:
+ parent = node._chain[-1]
+ else:
+ parent = None
+
+ if parent is None:
+ return '%s.%s' % (node.namespace.name, node.name)
+
if isinstance(node, (ast.Property, ast.Signal, ast.VFunction)):
- return '%s-%s' % (make_page_id(node.parent, recursive=True), node.name)
+ return '%s-%s' % (make_page_id(parent, recursive=True), node.name)
else:
- return '%s.%s' % (make_page_id(node.parent, recursive=True), node.name)
+ return '%s.%s' % (make_page_id(parent, recursive=True), node.name)
def get_node_kind(node):
if isinstance(node, ast.Namespace):
@@ -314,7 +322,10 @@ class DocFormatter(object):
return make_page_id(node)
def format_xref(self, node, **attrdict):
- if isinstance(node, ast.Member):
+ if node is None:
+ attrs = [('xref', 'index')] + attrdict.items()
+ return xmlwriter.build_xml_tag('link', attrs)
+ elif isinstance(node, ast.Member):
# Enum/BitField members are linked to the main enum page.
return self.format_xref(node.parent, **attrdict) + '.' + node.name
else:
@@ -587,27 +598,25 @@ class DocWriter(object):
# directory already made
pass
- nodes = [self._transformer.namespace]
- for node in self._transformer.namespace.itervalues():
- if isinstance(node, ast.Function) and node.moved_to is not None:
- continue
- if getattr(node, 'disguised', False):
- continue
- nodes.append(node)
- if isinstance(node, (ast.Class, ast.Interface, ast.Record)):
- nodes += getattr(node, 'methods', [])
- nodes += getattr(node, 'static_methods', [])
- nodes += getattr(node, 'virtual_methods', [])
- nodes += getattr(node, 'properties', [])
- nodes += getattr(node, 'signals', [])
- nodes += getattr(node, 'constructors', [])
- for node in nodes:
- if self._formatter.should_render_node(node):
- self._render_node(node, output)
-
- def _render_node(self, node, output):
+ self._walk_node(output, self._transformer.namespace, [])
+ self._transformer.namespace.walk(lambda node, chain: self._walk_node(output, node, chain))
+
+ def _walk_node(self, output, node, chain):
+ if isinstance(node, ast.Function) and node.moved_to is not None:
+ return False
+ if getattr(node, 'disguised', False):
+ return False
+ if self._formatter.should_render_node(node):
+ self._render_node(node, chain, output)
+ return True
+ return False
+
+ def _render_node(self, node, chain, output):
namespace = self._transformer.namespace
+ # A bit of a hack...maybe this should be an official API
+ node._chain = list(chain)
+
page_kind = get_node_kind(node)
template_name = '%s/%s.tmpl' % (self._language, page_kind)
page_id = make_page_id(node)
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.AnnotationObject.watch.page b/tests/scanner/Regress-1.0-C-expected/Regress.AnnotationObject.watch.page
index 0f9933de..76402aab 100644
--- a/tests/scanner/Regress-1.0-C-expected/Regress.AnnotationObject.watch.page
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.AnnotationObject.watch.page
@@ -38,7 +38,7 @@ void regress_annotation_object_watch (RegressAnnotationObject* object,
This is here just for the sake of being overriden by its
-.
+.
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.get_contained_type.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.get_contained_type.page
new file mode 100644
index 00000000..1ee353fd
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.get_contained_type.page
@@ -0,0 +1,48 @@
+
+
+
+
+
+
+
+ int
+
+ regress_foo_bunion_get_contained_type
+
+ RegressFooBUnion*
+ bunion
+
+
+
+
+ regress_foo_bunion_get_contained_type
+
+
+int regress_foo_bunion_get_contained_type (RegressFooBUnion* bunion);
+
+
+
+
+
+
+
+
+
+-
+
bunion
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.new.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.new.page
new file mode 100644
index 00000000..b760f204
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooBUnion.new.page
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+ RegressFooBUnion*
+
+ regress_foo_bunion_new
+
+
+
+ regress_foo_bunion_new
+
+
+RegressFooBUnion* regress_foo_bunion_new (void);
+
+
+
+
+
+
+
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.method.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.method.page
new file mode 100644
index 00000000..6ecf2dd9
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.method.page
@@ -0,0 +1,48 @@
+
+
+
+
+
+
+
+ int
+
+ regress_foo_enum_type_method
+
+ RegressFooEnumType
+ regress_foo_enum
+
+
+
+
+ regress_foo_enum_type_method
+
+
+int regress_foo_enum_type_method (RegressFooEnumType regress_foo_enum);
+
+
+
+
+
+
+
+
+
+-
+
regress_foo_enum
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.returnv.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.returnv.page
new file mode 100644
index 00000000..aa0c6c1b
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooEnumType.returnv.page
@@ -0,0 +1,48 @@
+
+
+
+
+
+
+
+ RegressFooEnumType
+
+ regress_foo_enum_type_returnv
+
+ int
+ x
+
+
+
+
+ regress_foo_enum_type_returnv
+
+
+RegressFooEnumType regress_foo_enum_type_returnv (int x);
+
+
+
+
+
+
+
+
+
+-
+
x
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooError.quark.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooError.quark.page
new file mode 100644
index 00000000..dde46fb0
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooError.quark.page
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+ GQuark
+
+ regress_foo_error_quark
+
+
+
+ regress_foo_error_quark
+
+
+GQuark regress_foo_error_quark (void);
+
+
+
+
+
+
+
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooInterfaceIface.do_regress_foo.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooInterfaceIface.do_regress_foo.page
new file mode 100644
index 00000000..0b900420
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooInterfaceIface.do_regress_foo.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.FooInterfaceIface.do_regress_foo
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.read_fn.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.read_fn.page
new file mode 100644
index 00000000..39078bfc
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.read_fn.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.FooObjectClass.read_fn
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.virtual_method.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.virtual_method.page
new file mode 100644
index 00000000..2882c6d7
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooObjectClass.virtual_method.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.FooObjectClass.virtual_method
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.destroy_event.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.destroy_event.page
new file mode 100644
index 00000000..95136833
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.destroy_event.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.FooSubInterfaceIface.destroy_event
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_bar.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_bar.page
new file mode 100644
index 00000000..ec46cdde
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_bar.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.FooSubInterfaceIface.do_bar
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_baz.page b/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_baz.page
new file mode 100644
index 00000000..d0f58041
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.FooSubInterfaceIface.do_baz.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.FooSubInterfaceIface.do_baz
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestABCError.quark.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestABCError.quark.page
new file mode 100644
index 00000000..7ed5152f
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestABCError.quark.page
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+ GQuark
+
+ regress_test_abc_error_quark
+
+
+
+ regress_test_abc_error_quark
+
+
+GQuark regress_test_abc_error_quark (void);
+
+
+
+
+
+
+
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestEnum.param.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestEnum.param.page
new file mode 100644
index 00000000..542ba60c
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestEnum.param.page
@@ -0,0 +1,48 @@
+
+
+
+
+
+
+
+ const gchar*
+
+ regress_test_enum_param
+
+ RegressTestEnum
+ e
+
+
+
+
+ regress_test_enum_param
+
+
+const gchar* regress_test_enum_param (RegressTestEnum e);
+
+
+
+
+
+
+
+
+
+-
+
e
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestError.quark.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestError.quark.page
new file mode 100644
index 00000000..9140ac56
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestError.quark.page
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+ GQuark
+
+ regress_test_error_quark
+
+
+
+ regress_test_error_quark
+
+
+GQuark regress_test_error_quark (void);
+
+
+
+
+
+
+
+
+
+-
+
Returns
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved1.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved1.page
new file mode 100644
index 00000000..3aec1433
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved1.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.TestObjClass._regress_reserved1
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved2.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved2.page
new file mode 100644
index 00000000..8bfc4d19
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass._regress_reserved2.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.TestObjClass._regress_reserved2
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.allow_none_vfunc.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.allow_none_vfunc.page
new file mode 100644
index 00000000..b45f05d2
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.allow_none_vfunc.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.TestObjClass.allow_none_vfunc
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.matrix.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.matrix.page
new file mode 100644
index 00000000..312b198e
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestObjClass.matrix.page
@@ -0,0 +1,25 @@
+
+
+
+
+
+
+
+ Regress.TestObjClass.matrix
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/scanner/Regress-1.0-C-expected/Regress.TestOtherError.quark.page b/tests/scanner/Regress-1.0-C-expected/Regress.TestOtherError.quark.page
new file mode 100644
index 00000000..4ed8d539
--- /dev/null
+++ b/tests/scanner/Regress-1.0-C-expected/Regress.TestOtherError.quark.page
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+ GQuark
+
+ regress_test_unconventional_error_quark
+
+
+
+ regress_test_unconventional_error_quark
+
+
+GQuark regress_test_unconventional_error_quark (void);
+
+
+
+
+
+
+
+
+
+-
+
Returns
+
+
+
+
+
+
+
--
cgit v1.2.1