summaryrefslogtreecommitdiff
path: root/libvaladoc/documentation/wiki.vala
blob: 0f8f4929e45f7eda1c19c2c1b7f711fc075010f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* wiki.vala
 *
 * Copyright (C) 2008-2009 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 Gee;


public class Valadoc.WikiPage : Object, Documentation {
	public Content.Page documentation {
		protected set;
		get;
	}

	public string documentation_str {
		private set;
		get;
	}

	public string path {
		private set;
		get;
	}

	public string name {
		private set;
		get;
	}


	public Api.Package? package {
		get {
			return _package;
		}
	}

	private Api.Package _package;

	/**
	 * The corresponding file name
	 */
	public string? get_filename () {
		return Path.get_basename(this.path);
	}

	public WikiPage (string name, string path, Api.Package package) {
		this._package = package;
		this.name = name;
		this.path = path;
	}

	public void read (ErrorReporter reporter) {
		try {
			string content;
			FileUtils.get_contents (this.path, out content);
			this.documentation_str = content;
		} catch (FileError err) {
			reporter.simple_error (null, "Unable to read file '%s': %s", this.path, err.message);
		}
	}

	public void parse (DocumentationParser docparser, Api.Package pkg) {
		documentation = docparser.parse_wikipage (pkg, this);
	}
}


public class Valadoc.WikiPageTree : Object {
	private ArrayList<WikiPage> wikipages;


	public WikiPageTree () {
	}

	public Collection<WikiPage> get_pages () {
		return this.wikipages == null? Collection.empty<WikiPage> () : this.wikipages.read_only_view;
	}

	public WikiPage? search (string name) {
		if (this.wikipages == null) {
			return null;
		}

		foreach (WikiPage page in this.wikipages ) {
			if (page.name == name) {
				return page;
			}
		}
		return null;
	}

	private void create_tree_from_path (DocumentationParser docparser, Api.Package package,
										ErrorReporter reporter, string path, string? nameoffset = null)
	{
		try {
			Dir dir = Dir.open (path);

			for (string? curname = dir.read_name (); curname!=null ; curname = dir.read_name ()) {
				string filename = Path.build_filename (path, curname);
				if (curname.has_suffix (".valadoc") && FileUtils.test (filename, FileTest.IS_REGULAR)) {
					WikiPage wikipage = new WikiPage ((nameoffset!=null)
						? Path.build_filename (nameoffset, curname)
						: curname, filename, package);
					this.wikipages.add(wikipage);
					wikipage.read (reporter);
				} else if (FileUtils.test (filename, FileTest.IS_DIR)) {
					this.create_tree_from_path (docparser, package, reporter, filename, (nameoffset!=null)
						? Path.build_filename (nameoffset, curname)
						: curname);
				}
			}
		} catch (FileError err) {
			reporter.simple_error (null, "Unable to open directory '%s': %s", path, err.message);
		}
	}

	public void parse (Settings settings, DocumentationParser docparser, Api.Package package, ErrorReporter reporter) {
		weak string path = settings.wiki_directory;
		if (path == null) {
			return ;
		}

		this.wikipages = new ArrayList<WikiPage> ();
		this.create_tree_from_path (docparser, package, reporter, path);

		foreach (WikiPage page in this.wikipages) {
			page.parse (docparser, package);
		}
	}

	public void check (Settings settings, DocumentationParser docparser, Api.Package pkg) {
		if (this.wikipages == null) {
			return ;
		}

		foreach (WikiPage page in this.wikipages) {
			docparser.check_wikipage (pkg, page);
		}
	}
}