current_builder.append (link.name);
}
}
-
+
public override void visit_link (Link link) {
current_builder.append_printf ("<ulink url=\"%s\">", link.url);
link.accept_children (this);
// If the symbol is a method and it doesn't have a constructor, fall back to linking to the class
if (sl.symbol is Method && ((Method) sl.symbol).is_constructor &&
((Method) sl.symbol).parent is Class && ((Class) ((Method) sl.symbol).parent).is_abstract) {
- current_builder.append (get_docbook_link (((Method) sl.symbol).parent, is_dbus) ?? sl.label);
+ current_builder.append (get_docbook_link (((Method) sl.symbol).parent, is_dbus) ?? sl.given_symbol_name);
} else {
- current_builder.append (get_docbook_link (sl.symbol, is_dbus) ?? sl.label);
+ current_builder.append (get_docbook_link (sl.symbol, is_dbus) ?? sl.given_symbol_name);
}
} else {
- current_builder.append (sl.label);
+ current_builder.append (sl.given_symbol_name);
}
}
-
+
public override void visit_list (Content.List list) {
string tag = "orderedlist";
switch (list.bullet) {
importer/valadocdocumentationimporter.vala \
importer/valadocdocumentationimporterscanner.vala \
importer/girdocumentationimporter.vala \
+ importer/internalidregistrar.vala \
api/symbolaccessibility.vala \
api/sourcecomment.vala \
api/girsourcecomment.vala \
return true;
}
+
+ internal void replace_node (Inline old, Inline replacement) {
+ int index = _content.index_of (old);
+ assert (index >= 0);
+
+ _content.set (index, replacement);
+ }
}
/* link.vala
*
* Copyright (C) 2008-2009 Didier Villevalois
- * Copyright (C) 2008-2012 Florian Brosch
+ * Copyright (C) 2008-2014 Florian Brosch
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
public class Valadoc.Content.Link : InlineContent, Inline {
public string url {
- get;
set;
+ get;
+ }
+
+ /**
+ * Used by importers to transform internal URLs
+ */
+ public Importer.InternalIdRegistrar id_registrar {
+ internal set;
+ get;
}
+
internal Link () {
base ();
}
public override void check (Api.Tree api_root, Api.Node container, string file_path,
ErrorReporter reporter, Settings settings)
{
- base.check (api_root, container, file_path, reporter, settings);
+
+ // Internal gktdoc-id? (gir-importer)
+ if (id_registrar != null) {
+ Api.Node? node = id_registrar.map_symbol_id (url);
+ if (node != null) {
+ InlineContent _parent = parent as InlineContent;
+ assert (_parent != null);
+
+ SymbolLink replacement = new SymbolLink (node);
+ replacement.content.add_all (content);
+
+ replacement.check (api_root, container, file_path, reporter, settings);
+ _parent.replace_node (this, replacement);
+ return ;
+ }
+
+
+ string _url = id_registrar.map_url_id (url);
+ if (_url == null) {
+ string node_segment = (container is Api.Package)? "" : container.get_full_name () + ": ";
+ reporter.simple_warning ("%s: %s[[: warning: unknown imported internal id `%s'", file_path, node_segment, url);
+
+ InlineContent _parent = parent as InlineContent;
+ assert (_parent != null);
+
+ Run replacement = new Run (Run.Style.ITALIC);
+ replacement.content.add_all (content);
+ replacement.check (api_root, container, file_path, reporter, settings);
+
+ _parent.replace_node (this, replacement);
+ return ;
+ }
+
+ url = _url;
+ }
+
+
//TODO: check url
+ base.check (api_root, container, file_path, reporter, settings);
}
public override void accept (ContentVisitor visitor) {
public override ContentElement copy (ContentElement? new_parent = null) {
Link link = new Link ();
+ link.id_registrar = id_registrar;
link.parent = new_parent;
link.url = url;
/* symbollink.vala
*
* Copyright (C) 2008-2009 Didier Villevalois
- * Copyright (C) 2008-2012 Florian Brosch
+ * Copyright (C) 2008-2014 Florian Brosch
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
using Gee;
-public class Valadoc.Content.SymbolLink : ContentElement, Inline {
+public class Valadoc.Content.SymbolLink : InlineContent, Inline {
public Api.Node symbol {
get;
set;
}
- public string label {
+ public string given_symbol_name {
get;
set;
}
- internal SymbolLink (Api.Node? symbol = null, string? label = null) {
+ internal SymbolLink (Api.Node? symbol = null, string? given_symbol_name = null) {
base ();
_symbol = symbol;
- _label = label;
+ _given_symbol_name = given_symbol_name;
}
public override void configure (Settings settings, ResourceLocator locator) {
}
public override ContentElement copy (ContentElement? new_parent = null) {
- SymbolLink link = new SymbolLink (symbol, label);
+ SymbolLink link = new SymbolLink (symbol, _given_symbol_name);
link.parent = new_parent;
+
+ foreach (Inline element in content) {
+ Inline copy = element.copy (link) as Inline;
+ link.content.add (copy);
+ }
+
return link;
}
}
public class Valadoc.DocumentationParser : Object, ResourceLocator {
- private HashMap<Api.SourceFile, GirMetaData> metadata = new HashMap<Api.SourceFile, GirMetaData> ();
+ private HashMap<Api.SourceFile, GirMetaData> metadata;
+ private Importer.InternalIdRegistrar id_registrar;
+
public DocumentationParser (Settings settings, ErrorReporter reporter,
Api.Tree tree, ModuleLoader modules)
gtkdoc_parser = new Gtkdoc.Parser (settings, reporter, tree, modules);
gtkdoc_markdown_parser = new Gtkdoc.MarkdownParser (settings, reporter, tree, modules);
+
+ metadata = new HashMap<Api.SourceFile, GirMetaData> ();
+ id_registrar = new Importer.InternalIdRegistrar ();
+
init_valadoc_rules ();
}
Comment doc_comment = gtkdoc_parser.parse (element, gir_comment, metadata);
return doc_comment;
} else {
- Comment doc_comment = gtkdoc_markdown_parser.parse (element, gir_comment, metadata);
+ Comment doc_comment = gtkdoc_markdown_parser.parse (element, gir_comment, metadata, id_registrar);
return doc_comment;
}
} else {
}
metadata = new GirMetaData (gir_comment.file.relative_path, _settings.metadata_directories, _reporter);
+ if (metadata.index_sgml != null) {
+ id_registrar.read_index_sgml_file (metadata.index_sgml, _reporter);
+ }
+
this.metadata.set (gir_comment.file, metadata);
return metadata;
}
/* girmetadata.vala
*
- * Copyright (C) 2012 Florian Brosch
+ * Copyright (C) 2012-2014 Florian Brosch
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* Brosch Florian <flo.brosch@gmail.com>
*/
+using Gee;
+
+
/**
* Metadata reader for GIR files
*/
private string? metadata_path = null;
private string? resource_dir = null;
+
public bool is_docbook { private set; get; default = false; }
+ public string index_sgml { private set; get; default = null; }
/**
this.is_docbook = key_file.get_boolean ("General", "is_docbook");
break;
+ case "index_sgml":
+ this.index_sgml = key_file.get_string ("General", "index_sgml");
+ break;
+
default:
reporter.simple_warning ("%s: warning: Unknown key 'General.%s'", metadata_path, key);
break;
} catch (KeyFileError e) {
reporter.simple_error ("%s: error: %s", metadata_path, e.message);
}
+
+
+ // Load internal link lut:
}
}
private Valadoc.Token preserved_token = null;
private Regex regex_source_lang;
+ private Importer.InternalIdRegistrar id_registrar;
private GirMetaData metadata;
private Api.GirSourceComment gir_comment;
private Api.Node element;
.set_reduce (() => {
Link url = _factory.create_link ();
url.url = pop_preserved_link ();
+ url.id_registrar = id_registrar;
Run label = (Run) peek ();
url.content.add_all (label.content);
}),
run,
Rule.option ({
- Valadoc.TokenType.MARKDOWN_HEADLINE_HASH.action (() => {
- // TODO
+ Valadoc.TokenType.MARKDOWN_HEADLINE_HASH.action ((token) => {
+ id_registrar.register_symbol (token.value, element);
})
}),
Valadoc.TokenType.MARKDOWN_HEADLINE_END
comment.content.insert (1, note);
}
- public Comment? parse (Api.Node element, Api.GirSourceComment gir_comment, GirMetaData metadata, string? this_name = null) {
+ public Comment? parse (Api.Node element, Api.GirSourceComment gir_comment, GirMetaData metadata, Importer.InternalIdRegistrar id_registrar, string? this_name = null) {
this.metadata = metadata;
+ this.id_registrar = id_registrar;
this.gir_comment = gir_comment;
this.element = element;
-
// main:
Comment? cmnt = _parse (gir_comment);
if (cmnt != null) {
this.metadata = null;
this.gir_comment = null;
- this.element = element;
+ this.id_registrar = null;
+ this.element = null;
return cmnt;
}
}
public override void visit_symbol_link (SymbolLink element) {
+ if (element.content.size > 0) {
+ writer.text ("\"");
+ element.accept_children (this);
+ writer.text ("\" (");
+ visit_symbol_link (element);
+ writer.text (")");
+ } else {
+ visit_symbol_link (element);
+ }
+ }
+
+ public void write_symbol_link (SymbolLink element) {
if (element.symbol == null) {
- writer.text (element.label);
+ writer.text (element.given_symbol_name);
} else {
write_docbook_link (element.symbol);
}
/* markupwriter.vala
*
- * Copyright (C) 2008-2009 Florian Brosch, Didier Villevalois
+ * Copyright (C) 2008-2014 Florian Brosch, Didier Villevalois
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
/* htmlrenderer.vala
*
- * Copyright (C) 2008-20012 Florian Brosch, Didier Villevalois
+ * Copyright (C) 2008-20014 Florian Brosch, Didier Villevalois
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
return linker.get_relative_link (_container, symbol, settings);
}
- private void write_unresolved_symbol_link (string label) {
- writer.start_tag ("code");
- writer.text (label);
- writer.end_tag ("code");
+ private void write_unresolved_symbol_link (string given_symbol_name, InlineContent? label_owner = null) {
+ if (label_owner == null || label_owner.content.size == 0) {
+ writer.start_tag ("code");
+ writer.text (given_symbol_name);
+ writer.end_tag ("code");
+ } else {
+ writer.start_tag ("i");
+ label_owner.accept_children (this);
+ writer.end_tag ("i");
+ }
}
- private void write_resolved_symbol_link (Api.Node symbol, string? given_label) {
- var label = (given_label == null || given_label == "") ? symbol.get_full_name () : given_label;
- if (symbol == _container || symbol == _owner) {
- writer.start_tag ("span", {"css", cssresolver.resolve (symbol)})
- .text (label)
- .end_tag ("span");
+ private void write_resolved_symbol_link (Api.Node symbol, string? given_symbol_name, InlineContent? label_owner = null) {
+ var symbol_name = (given_symbol_name == null || given_symbol_name == "") ? symbol.get_full_name () : given_symbol_name;
+ string href = (symbol == _container || symbol == _owner)? null : get_url (symbol);
+ string css_class = cssresolver.resolve (symbol);
+ string end_tag_name;
+
+
+ // Start Tag:
+ if (href != null) {
+ writer.start_tag ("a", {"href", href, "class", css_class});
+ end_tag_name = "a";
} else {
- var url = get_url (symbol);
- if (url == null) {
- write_unresolved_symbol_link (label);
- } else {
- writer.link (url, label, cssresolver.resolve (symbol));
- }
+ writer.start_tag ("span", {"class", css_class});
+ end_tag_name = "span";
}
+
+
+ // Content:
+ if (label_owner != null && label_owner.content.size > 0) {
+ label_owner.accept_children (this);
+ } else {
+ writer.text (symbol_name);
+ }
+
+
+ // End Tag:
+ writer.end_tag (end_tag_name);
}
private delegate void Write ();
public override void visit_symbol_link (SymbolLink element) {
if (element.symbol == null) {
- write_unresolved_symbol_link (element.label);
+ write_unresolved_symbol_link (element.given_symbol_name, element);
} else {
- write_resolved_symbol_link (element.symbol, element.label);
+ write_resolved_symbol_link (element.symbol, element.given_symbol_name, element);
}
}
*
* Copyright (C) 2008-2010 Jürg Billeter
* Copyright (C) 2011 Luca Bruno
- * Copyright (C) 2011-2012 Florian Brosch
+ * Copyright (C) 2011-2014 Florian Brosch
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
--- /dev/null
+/* gtkdocindexsgmlreader.vala
+ *
+ * Copyright (C) 2014 Florian Brosch
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Author:
+ * Florian Brosch <flo.brosch@gmail.com>
+ */
+
+using Valadoc;
+using Gee;
+
+
+public class Valadoc.Importer.InternalIdRegistrar {
+ private HashMap<string, Api.Node> symbol_map;
+ private HashMap<string, string> map;
+
+
+ public InternalIdRegistrar () {
+ map = new HashMap<string, string> ();
+ symbol_map = new HashMap<string, Api.Node> ();
+ }
+
+
+ public void register_symbol (string id, Api.Node symbol) {
+ this.symbol_map.set (id, symbol);
+ }
+
+ public string? map_url_id (string id) {
+ return map.get (id);
+ }
+
+ public Api.Node? map_symbol_id (string id) {
+ return symbol_map.get (id);
+ }
+
+
+ public void read_index_sgml_file (string filename, string? index_sgml_online, ErrorReporter reporter) {
+ MarkupSourceLocation begin;
+ MarkupSourceLocation end;
+ MarkupTokenType token;
+
+ string base_path = index_sgml_online ?? realpath (filename);
+ var reader = new MarkupReader (filename, reporter);
+
+ while ((token = reader.read_token (out begin, out end)) != MarkupTokenType.EOF) {
+ if (token == MarkupTokenType.START_ELEMENT && reader.name == "ONLINE") {
+ if (index_sgml_online == null) {
+ base_path = reader.get_attribute ("href");
+ if (base_path == null) {
+ reporter.error (filename, begin.line, begin.column, end.column, reader.get_line_content (begin.line), "missing attribute `href' in <ONLINE>");
+ }
+ }
+ } else if (token == MarkupTokenType.START_ELEMENT && reader.name == "ANCHOR") {
+ string id = reader.get_attribute ("id");
+ if (id == null) {
+ reporter.error (filename, begin.line, begin.column, end.column, reader.get_line_content (begin.line), "missing attribute `id' in <ANCHOR>");
+ }
+
+ string href = reader.get_attribute ("href");
+ if (href == null) {
+ reporter.error (filename, begin.line, begin.column, end.column, reader.get_line_content (begin.line), "missing attribute `href' in <ANCHOR>");
+ } else if (index_sgml_online != null) {
+ href = Path.get_basename (href);
+ }
+
+ map.set (id, Path.build_path ("/", base_path, href));
+ } else {
+ reporter.error (filename, begin.line, begin.column, end.column, reader.get_line_content (begin.line), "expected element of <ONLINE> or <ANCHOR>");
+ }
+ }
+ }
+}
+
+
/* taglet.vala
*
* Copyright (C) 2008-2009 Didier Villevalois
- * Copyright (C) 2008-2012 Florian Brosch
+ * Copyright (C) 2008-2014 Florian Brosch
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
public override ContentElement produce_content () {
var link = new Content.SymbolLink ();
link.symbol = _symbol;
- link.label = symbol_name;
+ link.given_symbol_name = symbol_name;
Content.Inline content;
switch (_context) {
case SymbolContext.FINISH:
- link.label += ".end";
+ link.given_symbol_name += ".end";
content = link;
break;
projects / thirdparty / vala.git / commitdiff
