Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: e47abb014a6434cbf5fde1b13c8dba928bb3a2fc (plain) (blame)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<?xml version="1.0" encoding="UTF-8"?>
<project name="Platform Doc Isv Build" default="all"  basedir="." >

	<property file="${basedir.properties}"/>

	<target name="init">
		<available file="${basedir}/index" property="index.present"/>
	</target>

	<target name="all" depends="init" unless="index.present">
		<antcall target="convertSchemaToHtml" />
		<antcall target="examplesDocCopy" />
		<antcall target="generateJavadoc" />
		<antcall target="build.index" />
		<!--antcall target="createDocZip" /-->
	</target>


	<target name="build.index" description="Builds search index for the plug-in: org.eclipse.platform.doc.isv" if="eclipse.running">
		<help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}"/>
	</target>

	<target name="convertSchemaToHtml" if="eclipse.running">
		<property name="dest" value="reference/extension-points" />

		<record name="${basedir}/platformconvert.txt" action="start"/>
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ant}/org.eclipse.ant.core/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ant}/org.eclipse.ant.ui/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.team.bundles}/org.eclipse.compare/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.runtime.bundles}/org.eclipse.core.contenttype/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.runtime.bundles}/org.eclipse.core.expressions/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.text}/org.eclipse.core.filebuffers/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.resources.bundles}/org.eclipse.core.filesystem/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.resources.bundles}/org.eclipse.core.resources/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.runtime.bundles}/org.eclipse.core.runtime/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.debug}/org.eclipse.core.variables/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.debug}/org.eclipse.debug.core/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.debug}/org.eclipse.debug.ui/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ui.bundles}/org.eclipse.e4.ui.workbench/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${rt.equinox.bundles.bundles}/org.eclipse.equinox.preferences/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${rt.equinox.bundles.bundles}/org.eclipse.equinox.app/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${rt.equinox.bundles.bundles}/org.eclipse.equinox.bidi/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${rt.equinox.bundles.bundles}/org.eclipse.equinox.http.registry/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${rt.equinox.bundles.bundles}/org.eclipse.equinox.registry/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${rt.equinox.bundles.bundles}/org.eclipse.equinox.security/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ua}/org.eclipse.help/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ua}/org.eclipse.help.base/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ua}/org.eclipse.help.ui/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ua}/org.eclipse.help.webapp/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.jdt.ui}/org.eclipse.ltk.core.refactoring/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.jdt.ui}/org.eclipse.ltk.ui.refactoring/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.text}/org.eclipse.search/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.team.bundles}/org.eclipse.team.core/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.team.bundles}/org.eclipse.team.ui/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ui.bundles}/org.eclipse.ui/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ui.bundles}/org.eclipse.ui.browser/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ua}/org.eclipse.ui.cheatsheets/plugin.xml" destination="${dest}" />
		<!--copy extra files linked to by generated extension point doc-->
		<copy file="${eclipse.platform.ua}/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html" todir="${dest}"/>
		<copy file="${eclipse.platform.ua}/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.exsd" todir="${dest}"/>
		<copy file="${eclipse.platform.ua}/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html" todir="${dest}"/>
		<copy file="${eclipse.platform.ua}/org.eclipse.ui.cheatsheets/schema/compositeContentFile.exsd" todir="${dest}"/>

		<pde.convertSchemaToHTML manifest="${eclipse.platform.debug}/org.eclipse.ui.console/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.text}/org.eclipse.ui.editors/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.debug}/org.eclipse.ui.externaltools/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ui.bundles}/org.eclipse.ui.ide/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ua}/org.eclipse.ui.intro/plugin.xml" destination="${dest}" />
		<!--copy extra HTML file linked to by generated extension point doc-->
		<copy file="${eclipse.platform.ua}/org.eclipse.ui.intro/schema/introContentFileSpec.html" todir="${dest}"/>
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ui.bundles}/org.eclipse.ui.navigator/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.ui.bundles}/org.eclipse.ui.views.properties.tabbed/plugin.xml" destination="${dest}" />
		<pde.convertSchemaToHTML manifest="${eclipse.platform.text}/org.eclipse.ui.workbench.texteditor/plugin.xml" destination="${dest}" />
		<record name="${basedir}/platformconvert.txt" action="stop"/>
	</target>

	<target name="examplesDocCopy" >
		<copy todir="samples">
			<fileset dir=".">
				<include name="${eclipse.platform.team.examples}/org.eclipse.compare.examples/doc-html/"/>
				<include name="${eclipse.platform.team.examples}/org.eclipse.compare.examples.xml/doc-html/"/>				
				<include name="${eclipse.platform.swt.examples}/org.eclipse.swt.examples/doc-html/"/>
				<include name="${eclipse.platform.swt.examples}/org.eclipse.swt.examples.browser/doc-html/"/>
				<include name="${eclipse.platform.swt.examples}/org.eclipse.swt.examples.controls/doc-html/"/>
				<include name="${eclipse.platform.swt.examples}/org.eclipse.swt.examples.launcher/doc-html/"/>
				<include name="${eclipse.platform.swt.examples}/org.eclipse.swt.examples.layouts/doc-html/"/>
				<include name="${eclipse.platform.swt.examples}/org.eclipse.swt.examples.ole.win32/doc-html/"/>
				<include name="${eclipse.platform.swt.examples}/org.eclipse.swt.examples.paint/doc-html/"/>
				<include name="${eclipse.platform.ui.examples}/org.eclipse.ui.examples.fieldassist/doc-html/"/>
				<include name="${eclipse.platform.ui.examples}/org.eclipse.ui.examples.javaeditor/doc-html/"/>
				<include name="${eclipse.platform.ui.examples}/org.eclipse.ui.examples.multipageeditor/doc-html/"/>
				<include name="${eclipse.platform.ui.examples}/org.eclipse.ui.examples.propertysheet/doc-html/"/>
				<include name="${eclipse.platform.ui.examples}/org.eclipse.ui.examples.readmetool/doc-html/"/>
				<include name="${eclipse.platform.ui.examples}/org.eclipse.ui.examples.undo/doc-html/"/>
				<include name="${eclipse.platform.team.examples}/org.eclipse.team.examples.filesystem/doc-html/"/>
			</fileset>
		</copy>
	</target>

	<target name="getJavadocPath">
		<available file="${java.home}/../bin/javadoc.exe" property="javadoc" value="${java.home}/../bin/javadoc.exe"/>
		<available file="${java.home}/../bin/javadoc" property="javadoc" value="${java.home}/../bin/javadoc" />
	</target>

	<target name="generateJavadoc" depends="getJavadocPath">
		<property name="javadoc16" value="${javadoc}" />

		<!-- replace "\n;" with platform-dependent list entry delimiter -->
		<property name="optionsFile" value="platformOptions.tmp.txt" />
		<copy file="platformOptions.txt" tofile="${optionsFile}" overwrite="true" />
		
		<condition property="argsListDelimiter" value=":">
			<os family="unix" />
		</condition>
		<condition property="argsListDelimiter" value=";">
			<os family="windows" />
		</condition>
		
		<replaceregexp file="${basedir}/${optionsFile}" flags="g" match="(\r\n?|\n);" replace="${argsListDelimiter}" />
		<replace file="${basedir}/${optionsFile}" token="@rt@" value="${bootclasspath}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.jdt.ui@" value="${eclipse.jdt.ui}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.pde@" value="${eclipse.pde}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.ant@" value="${eclipse.platform.ant}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.debug@" value="${eclipse.platform.debug}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.platform@" value="${eclipse.platform.platform}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.resources.bundles@" value="${eclipse.platform.resources.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.runtime.bundles@" value="${eclipse.platform.runtime.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.swt.bundles@" value="${eclipse.platform.swt.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.team.bundles@" value="${eclipse.platform.team.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.text@" value="${eclipse.platform.text}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.ua@" value="${eclipse.platform.ua}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.ui.bundles@" value="${eclipse.platform.ui.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.update@" value="${eclipse.platform.update}" />
		<replace file="${basedir}/${optionsFile}" token="@rt.equinox.bundles.bundles@" value="${rt.equinox.bundles.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@rt.equinox.framework.bundles@" value="${rt.equinox.framework.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@rt.equinox.p2.bundles@" value="${rt.equinox.p2.bundles}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.team.examples@" value="${eclipse.platform.team.examples}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.swt.examples@" value="${eclipse.platform.swt.examples}" />
		<replace file="${basedir}/${optionsFile}" token="@eclipse.platform.ui.examples@" value="${eclipse.platform.ui.examples}" />
                <replace file="${basedir}/${optionsFile}" token="@eclipse.equinox.http.jetty@" value="${eclipse.equinox.http.jetty}" />
		
		<!-- expand _* to actual version -->
			<!-- prepare ${replaceFile} with all files and folders from workspace -->
		<fileset dir="${basedir}/${dependency.dir}" id="fileSet">
			<include name="*"/>
		</fileset>
		<dirset dir="${basedir}/${dependency.dir}" id="dirSet">
			<include name="*"/>
		</dirset>
		<pathconvert property="fileList" refid="fileSet" dirsep="/" pathsep="&#xA;"/>
		<pathconvert property="dirList" refid="dirSet" dirsep="/" pathsep="&#xA;"/>
		<property name="replaceFile" value="platformOptions.replace.txt" />
		<echo file="${basedir}/${replaceFile}">${fileList}&#xA;${dirList}</echo>

			<!-- strip away leading path -->
		<replaceregexp file="${basedir}/${replaceFile}" flags="g" match="(?m)^.*/([^/]*)$$" replace="\1" />
			<!-- remove lines without "_" -->
		<replaceregexp file="${basedir}/${replaceFile}" flags="g" match="(?m)^[^_\r\n]*$$" replace="" />
			<!-- create "aa_*[.jar]=aa_[version][.jar]" property for lines with a "_" -->
		<replaceregexp file="${basedir}/${replaceFile}" flags="g" match="(?m)^([^_]*)_.*?(.jar)?$$" replace="\1_*\2=\0" />
		
		<replace file="${basedir}/${optionsFile}" replacefilterfile="${basedir}/${replaceFile}"/>

		<!--scrub isv plugin directories of any preexisting api doc content-->
		<delete dir="reference/api"/>
		<mkdir dir="reference/api"/>

		<exec dir="." executable="${javadoc16}" output="doc.bin.log">
			<arg line="@${basedir}/${optionsFile} -J-Xmx1000M" />
		</exec>
		
<!-- Debugging: Add a snapshot of the workspace contents: 
		<fileset dir="${basedir}/.." id="fileSet">
			<include name="*"/>
			<include name="*/*"/>
		</fileset>
		<dirset dir="${basedir}/.." id="dirSet">
			<include name="*"/>
			<include name="*/*"/>
		</dirset>
		<pathconvert property="fileList" refid="fileSet" dirsep="/" pathsep="&#xA;"/>
		<pathconvert property="dirList" refid="dirSet" dirsep="/" pathsep="&#xA;"/>
		<echo file="doc.bin.log" append="true">
Workspace Contents:
Files:
${fileList}
Directories:
${dirList}
</echo>
-->
		
		<!--workaround for bug 101048-->
		<replace dir="reference/api" token="=&quot;/../misc/api-usage-rules.html" value="=&quot;./../misc/api-usage-rules.html">
			<include name="*htm*" />
		</replace>

	</target>

	<target name="createDocZip">
		<zip zipfile="${basedir}/doc.zip" basedir="${basedir}" includes="book.css, notices.html, about.html, concepts/**, gettingStarted/**, images/**, reference/**, porting/**, tasks/**,samples/**,guide/**,questions/**" />
	</target>
</project>

Back to the top