# HG changeset patch
# User noe\swadi
# Date 1263011651 -19800
# Node ID a02c979e8dfd8feb8c09ce7571b81273a7c9a10b
1. Copyrights changed to EPL
2. Feature updates mentioned in release notes.
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/.project
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/.project Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,17 @@
+
+
+ com.nokia.carbide.extensions.apiquery
+
+
+
+
+
+ org.eclipse.pde.FeatureBuilder
+
+
+
+
+
+ org.eclipse.pde.FeatureNature
+
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/build.properties
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/build.properties Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,2 @@
+bin.includes = feature.xml,\
+ license.txt
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/feature.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/feature.xml Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,67 @@
+
+
+
+
+ API Query is tool to search for information about the APIs used in S60 projects.
+
+
+
+ Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+All rights reserved. License:http://www.eclipse.org/legal/epl-v10.html.
+
+
+
+ Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+ All rights reserved.
+
+ This component and the accompanying materials are made available
+ under the terms of "Eclipse Public License v1.0"
+ which accompanies this distribution, and is available
+ at the URL "http://www.eclipse.org/legal/epl-v10.html".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/license.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.carbide.extensions.apiquery/license.txt Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,8 @@
+
+ Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+ All rights reserved.
+
+ This component and the accompanying materials are made available
+ under the terms of "Eclipse Public License v1.0"
+ which accompanies this distribution, and is available
+ at the URL "http://www.eclipse.org/legal/epl-v10.html".
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/.project
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/.project Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,28 @@
+
+
+ com.nokia.s60tools.apiquery.cache.help
+
+
+
+
+
+ org.eclipse.pde.ManifestBuilder
+
+
+
+
+ org.eclipse.pde.SchemaBuilder
+
+
+
+
+ com.nokia.carbide.extension.pclint.pclintAuditor
+
+
+
+
+
+ org.eclipse.pde.PluginNature
+ com.nokia.carbide.extension.pclint.pclintNature
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/META-INF/MANIFEST.MF
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/META-INF/MANIFEST.MF Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,7 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: Carbice.c++ Extensions - API Query Metadata information from the SDK Help Plug-in
+Bundle-SymbolicName: com.nokia.s60tools.apiquery.cache.help;singleton:=true
+Bundle-Version: 1.2.6
+Bundle-Vendor: Nokia
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/book.css
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/book.css Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,191 @@
+/*
+
+ Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+ All rights reserved.
+
+ This component and the accompanying materials are made available
+ under the terms of "Eclipse Public License v1.0"
+ which accompanies this distribution, and is available
+ at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*/
+
+/* Add whitespace around entire display to avoid crowding edges of view */
+/* 20070523-Removed top margin size to close gap between location breadcrumbs and page title */
+html {
+ margin: 0px 10px 10px 10px;
+ }
+
+/* Set default font to serif style, 12-pt and plain */
+body, p, table {
+ font-family: Georgia, "Times New Roman", Times, serif;
+ font-size: 12px;
+ font-weight: normal;
+}
+
+/* Use sans-serif fonts for all title styles */
+h1, h2, h3, h4, h5, h6, strong, em {
+ font-family: Helvetica, sans-serif;
+ color: #000000;
+ }
+
+h1 { font-size:20px }
+h2 { font-size:18px }
+h3 { font-size:16px }
+h4 { font-size:14px }
+h5 { font-size:12px }
+h6 { font-size:10px }
+
+/* For headlines at the top of a view, add space */
+/* 20070522-added gradiant to background to update visual style of docs */
+h1, h2, h3 {
+ background-image: url(html/images/green_fade_left_68_165_28.png);
+ background-repeat: no-repeat;
+ padding:10px 0px 10px 12px;
+ }
+
+li {
+ margin-bottom:8px;
+ margin-top:8px;
+ }
+
+/* Footer includes space and a gray line above the company logo */
+#footer {
+ padding-top:10px;
+ margin-top:20px;
+ border-top:1px solid #999;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ font-size: 10px;
+ color: #03C;
+ }
+
+.listing {
+ font-family: "Courier New", Courier, mono;
+ color: #009;
+ background-color: #EEE;
+ padding: 10px 0px;
+ margin: 10px 0px;
+ }
+
+.code, pre {
+ font-family: "Courier New", Courier, mono;
+ font-size: 11px;
+ color: #333;
+ }
+
+.step {
+ /* background-color: #EEE; */
+ /* margin: 10px 0px; */
+ color: #333;
+ border-bottom:2px solid #EEE;
+ }
+
+.substep {
+ background-color: #EEE;
+ }
+
+
+/* Figure/Listing/Table titles are centered and gray */
+p.table {
+ color: #999;
+ font-weight: bold;
+ padding-top: 5px;
+ }
+
+table {
+ border: solid #999 1px;
+ table-layout: auto;
+ font-size: 12px;
+ }
+
+td, th {
+ border: solid #999 1px;
+ padding: 5px;
+ vertical-align:top;
+ }
+
+/* 20070522-replaced gray with green background to match gradiant color for title */
+th {
+ background-color:#ACD79B;
+ /* background-color:#999;
+ color:#FFF; */
+ }
+
+div.ol.p {
+ margin-left: 3em;
+ }
+
+/* Make all ordered/unordered list items appear in bold gray */
+div ol > li, div ul > li {
+ font-weight:bold;
+ color: #333;
+ }
+
+div ol > p, div ul > p, div li > p {
+ font-weight:normal;
+ }
+
+/* Make all H4 and H5 items appear in bold gray against a light green background */
+div h5, div h4 {
+ padding:5px 0px 5px 12px;
+ background-color:#ECFBEA;
+ /* background-color: #EEE; */
+ font-weight:bold;
+ color: #333;
+ }
+
+
+/* Notes stand out using a light top & bottom borders with dark gray text */
+p.note {
+ /* color: #03C; */
+ /* background-color: #FFFF99; */
+ color: #333;
+ padding: 5px;
+ margin-left: 1em;
+ margin-right: 1em;
+ border-top: solid #BBB thin;
+ border-bottom: solid #BBB thin;
+ }
+
+
+/* Figure/Listing/Table titles are centered and gray */
+p.figure {
+ color: #333;
+ text-align: center;
+ font-weight: bold;
+ }
+
+/* highly visible red background and white text for things that need fixing before release */
+/* SHOULD NOT BE PRESENT IN RELEASED PRODUCTS */
+.fix {
+ background-color: red;
+ font-weight: bold;
+ color: white;
+ }
+
+.question {
+ font-style:italic;
+ font-weight:bold;
+ color: #555;
+ }
+
+.titleSmall {
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ font-size: 10px;
+ }
+
+
+.plain {
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ font-size: 12px;
+ font-style: normal;
+ line-height: normal;
+ font-weight: normal;
+ font-variant: normal;
+ color: #000000;
+ text-decoration: none;
+ }
+
+a:link { color: #0033CC }
+a:visited { color: #555555 }
+a:hover { color: #0033CC }
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/build.properties
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/build.properties Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,7 @@
+output.. = bin/
+bin.includes = plugin.xml,\
+ META-INF/,\
+ .,\
+ html/,\
+ book.css
+bin.excludes = html/nokia.css
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/contexts.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/contexts.xml Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+ Properties tab
+
+
+
+
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/images/green_fade_left_68_165_28.png
Binary file srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/images/green_fade_left_68_165_28.png has changed
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/index.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/index.xml Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/nokia.css
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/nokia.css Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,170 @@
+/*
+ Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+ All rights reserved.
+
+ This component and the accompanying materials are made available
+ under the terms of "Eclipse Public License v1.0"
+ which accompanies this distribution, and is available
+ at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*/
+
+/* Add whitespace around entire display to avoid crowding edges of view */
+html {
+ margin: 10px;
+ /* fixes gray backgrounds when displayed in external browsers */
+ background-color:#FFFFFF;
+ }
+
+/* Set default font to serif style, 12-pt and plain */
+body {
+ font-family: Georgia, "Times New Roman", Times, serif;
+ font-size: 12px;
+ font-weight: plain;
+}
+
+/* Use sans-serif fonts for all title styles and Nokia blue */
+h1, h2, h3, h4, h5, h6, strong, em {
+ font-family: Arial, Helvetica, sans-serif;
+ color: #333;
+ }
+
+strong{
+ color: #333;
+ }
+
+/* For headlines at the top of a view, add space and a gray line underneath */
+h2, h3 {
+ padding:10px 0px;
+ border-bottom:1px solid #BBB;
+ }
+
+li {
+ margin-bottom:8px;
+ margin-top:8px;
+ }
+
+
+/* Footer includes space and a gray line above the company logo */
+#footer {
+ padding-top:10px;
+ margin-top:20px;
+ border-top:1px solid #999;
+ font-family: Arial, Helvetica, sans-serif;
+ font-size: 11px;
+ color: #333;
+ }
+
+.listing {
+ font-family: "Courier New", Courier, mono;
+ color: #009;
+ background-color: #EEE;
+ padding: 10px 0px;
+ margin: 10px 0px;
+ }
+
+.code, pre {
+ font-family: "Courier New", Courier, mono;
+ font-size: 12px;
+ color: #333;
+ }
+
+.step {
+ /* background-color: #EEE; */
+ /* margin: 10px 0px; */
+ color: #333;
+ border-bottom:2px solid #EEE;
+ }
+
+.substep {
+ background-color: #EEE;
+ }
+
+
+/* Figure/Listing/Table titles are centered and gray */
+p.table {
+ color: #999;
+ font-weight: bold;
+ padding-top: 5px;
+ }
+
+table {
+ border: 1px solid #999;
+ table-layout: auto;
+ }
+
+td, th {
+ border: 1px solid #999;
+ padding: 5px;
+ vertical-align:top;
+ }
+
+th {
+ background-color:#999;
+ color:#FFF;
+ }
+
+div.ol.p {
+ margin-left: 3em;
+ }
+
+/* Make all ordered/unordered list items appear in bold gray */
+div ol > li, div ul > li {
+ font-weight:bold;
+ color: #333;
+ }
+
+/* Make all H4 and H5 items appear in bold gray against a light gray background */
+div h5, div h4 {
+ padding: 5px;
+ background-color: #EEE;
+ font-weight:bold;
+ color: #333;
+ }
+
+
+/* Notes stand out using a light top & bottom borders with dark gray text */
+p.note {
+ /* color: #03C; */
+ /* background-color: #FFFF99; */
+ color: #333;
+ padding: 5px;
+ margin-left: 1em;
+ margin-right: 1em;
+ border-top:1px solid #BBB;
+ border-bottom:1px solid #BBB;
+}
+
+
+/* Figure/Listing/Table titles are centered and gray */
+p.figure {
+ color: #333;
+ text-align: center;
+ font-weight: bold;
+}
+
+/* red background and white text for things that need fixing before release */
+.fix {
+ background-color: red;
+ font-weight: bold;
+ color: white;
+ }
+
+.question {
+ font-style:italic;
+ font-weight:bold;
+ color: #333;
+ }
+
+.titleSmall {
+ font-family: Arial, Helvetica, sans-serif;
+ font-size: 10px;
+ }
+
+.copyrightStatement {
+ font-size: 11px;
+ color: #006699; /* Symbian blue */
+ }
+
+div.Footer table, div.Footer td, div.Footer th {
+ border: 0px none #000;
+ }
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/propertiesTab.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/propertiesTab.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,51 @@
+
+
+
+
+Configuring the API metadata file data source properties
+
+
+
+
+
Configuring the API metadata file data source properties
+
Using the API metadata file data source from an SDK is a good option, for example, for cases when you have network restrictions for using the Web data source option. This data source only requires a suitable SDK to be present.
+
To configure the API metadata file data source, do the following:
+
+
On the Properties tab, select API Metadata files from the SDK from the Data Source drop-down list.
+
+
+From the listbox, select an SDK from your local workstation.To aid selection ,cached/uncached information is displayed against each sdk.
+
With applicable SDKs, API Query starts seeking for the existing .metaxml files from the SDK.
+
If you have problems with the SDK, see the Tips and hints below for more information.
+
+
+
+
Next, you can start an API query either from the Search tab or from the context menu of your project. For instructions, see the Tasks section in the Table of Contents in API Query Help.
+
+
Tips and hints for API metadata file data source
+
+
+
+
+
Situation
+
Solution
+
+
+
The selected SDK does not contain any API metadata .metaxml files.
+
The SDK cannot be used in API queries. Select another SDK and try again.
+
+
+
Some of the data sources cannot be loaded.
+
The SDK contains API metadata files that are not formally valid XML. These files are excluded from API queries.
(If possible, to fix the issue, notify the API's responsible person about the problem.)
+
+
+
The SDK contents have changed since it was first loaded.
+
You can refresh the local cache of the specified SDK by clicking Refresh cache.
Refreshing the SDK data is useful in cases when the metadata files have been updated or errors detected earlier have been corrected.
+
+
+
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/screenshots/sdk_data_source_properties.png
Binary file srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/screenshots/sdk_data_source_properties.png has changed
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/toc.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.cache.help/html/toc.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,18 @@
+
+
+
+
+API metadata file data source
+
+
+
+
+
API metadata file data source
+
The API metadata file data source enables the query of API information from a local software development kit (SDK) installed on your workstation.
+
Queries can be made only in SDKs that contain API metadata (.metaxml) files. In addition, only files that are valid XML are included in queries.
A data source is an external repository that stores information about Application Programming Interfaces (APIs).
+
The repository can be, for example:
+
+
a Web database service,
+
an API metadata file (.metaxml) obtained from a Software Development Kit (SDK).
+
+
API information identifies, for example, the header files, DLL files, subsystems, SDKs, and the contact persons for an API. However, different data sources contain different levels of detail. To check which data source suits your needs the best and how to take it into use, see the topics under Data source configurations.
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/concepts/metadata_file.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/concepts/metadata_file.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,35 @@
+
+
+
+
+API metadata file
+
+
+
+
+
API metadata file
+
A metadata file is used to provide information about an Application Programming Interface (API). Metadata files contain the following information of an API, as shown in the example below:
+
+<?xml version="1.0" ?>
+<api id="16bdb6fdf38e8ced9e907a4eea1f68c5" dataversion="1.0">
+ <name>Phone Parser API</name>
+ <description>This API is used to parse and validate phone numbers.</description>
+ <type>c++</type>
+ <subsystem>commonservices</subsystem>
+ <libs>
+ <lib name="CommonEngine.lib" />
+ </libs>
+ <release category="sdk" sinceversion="2.0"/>
+ <attributes>
+ <htmldocprovided>yes</htmldocprovided>
+ <adaptation>no</adaptation>
+ </attributes>
+</api>
+
+
Metadata files are identified by the extension .metaxml. The name of the file comes from the API name and should be the same as the API directory name. For example, if the API directory is phone_parser_api, the corresponding metadata file name should be phone_parser_api.metaxml. The file is located directly under the API's own directory.
+
Tip: These files can be created and edited in the Carbide.c++ development environment with the Metadata Editor tool. You can start the tool from the Carbide > Metadata Editor menu.
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/concepts/software_development_kit.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/concepts/software_development_kit.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,28 @@
+
+
+
+
+Software Development Kit (SDK)
+
+
+
+
+
Software Development Kit (SDK)
+
A Software Development Kit (SDK) contains the tools, documentation and code examples that support the development of applications. It also contains Application Programming Interface (API) metadata files (.metaxml) that you can specify as one data source type for your queries.
+
You can use both Public SDKs and RnD SDKs in queries. Public SDKs can be downloaded from the Internet (for example, from Forum Nokia pages), whereas RnD SDKs are more restricted but contain all system-level components.
+
To install SDKs to Carbide.c++, go to Windows > Preferences > Carbide.c++ > SDK Preferences > Add New SDK, and select the SDK to be added.
+
For more information, see SDK Support under the general Carbide.c++ help.
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/contexts.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/contexts.xml Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,20 @@
+
+
+
+
+
+ Search tab
+
+
+
+
+
+
+
+ Properties tab
+
+
+
+
+
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/datasources/datasources.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/datasources/datasources.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,17 @@
+
+
+
+
+
+Data source configurations
+
+
+
+
+
Data source configurations
+
This section of the help shows the documentation for currently installed data sources. Each data source implementation can be installed as a separate plug-in, and each plug-in provides its help under this category. Follow the topic links on the help's table of contents for more information.
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/gettingstarted/GS_index.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/gettingstarted/GS_index.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,24 @@
+
+
+
+
+ Getting Started
+
+
+
+
+
Getting started
+
+
The information in this section will help you get started quickly using the basic
+ features of the API Query extension for Carbide.c++.
API Query is a tool for querying Application Programming Interface (API) information. With this tool, you can quickly found out which headers belong to a specific API, who is the owner of a particular API, and whether the API has been published in an SDK.
+
API data is accessed via a data source, such as an online database service. For more information, see Data source.
+
You can use the following criteria when querying for API information (some of these may not be available with all data source types):
+
+
API name
+
subsystem name
+
DLL name
+
LIB name
+
header name
+
CR/P&S key name.
+
+
In the API Query tool, you can run a query either from the Search tab or directly from your code. In the code, you can either search for specific identifiers or generate a report about the usage of APIs in your entire project.
API Query is a tool for querying Application Programming Interface (API) information.
+
You can start the API Query tool either by selecting the Carbide > API Query menu item or via Window > Show View > Other... under Carbide Extensions category.
+
+
Features
+
+
API Query using metadata files (.metaxml) from an SDK.
+
API usage verification in an active project.
+
Usage logging when a search is executed.
+
+
+
Enhancements/Fixed
+
+
The search results list can show only API names.
+
The HTML report links start an API Query or open the selected file.
+
+
+
+
New Features
+
+
Search results are displayed with focus on the search criteria.
+
The value that fulfils the search criteria is shown highlighted with red.
+
Hyperlink to open the header file will be active.
+
Multi search support with keywords seperated by ;
+
In the API metadata file data source, Cached/Unchached information displayed against each sdk
+
Sorter for results
+
+
+
System requirements
+
Basic Requirements:
+
+
Windows 2000, Windows XP
+
Carbide.c++ v2.0
+
Minimum Platform/SDK build PC.
+
Normal Platform/SDK build PC.
+
+
Additional Requirements:
+
+
Carbide.c++ with all its prerequisites have to be installed prior to installation. ActivePerl-5.6.1.635 and at least one S60 3rd Edition SDK/Platform need to be installed. See readme\readme_sdks.html under the Carbide.c++ installation directory for more information on prerequisites.
+
+
+
+
Compatibility issues
+
+
N/A
+
+
+
Known issues
+
+
If multiple Carbide.C++ editor instances are running on same PC, active project report links may not work. Close other Carbide.C++ instances and rerun API Query for active project or restart API Query plug-in.
+
Context-sensitive help will not get focus when pressing F1 if the API Query plug-in is running in the same tab as the Help. The help will open to a relative item on F1 key press, and can be navigated to by clicking the Help tab.
+
+
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/configure_data_sources.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/configure_data_sources.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,30 @@
+
+
+
+
+Configuring data sources
+
+
+
+
+
Configuring data sources
+
Data sources are configured on the Properties Tab in the API Query tool. The currently used data source is selected from the list box. The contents of the configuration UI vary based on which data source is selected. There is no common rule for configuration UI, but it is normally divided into several data source entries that can be either taken into or omitted from an API search.
+
+
+
+
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_for_project.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_for_project.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,39 @@
+
+
+
+
+Running an API query for a project
+
+
+
+
+
Running an API query for a project
+
You can generate a report of the usage of APIs throughout your active project from the context menu.
+You can access the context menu either by right-clicking any .cpp or .h file or any folder in the C/C++ Projects view, or by right-clicking your code anywhere in the editor.
+
+
The report is a table in HTML format and is named as [name]-project_is_using_APIs.html by default. You can view it in Carbide's internal browser or in any Web browser.
+
To run a query for a project, do the following:
+
+
Right-click the item of your choice and from the pop-up menu, select API Query > for Active Project.
+
In the Save As dialog, select the location for saving the query report within your project and click OK.
+
When the report has been generated, click OK in the confirmation dialog to view it right away.
The report is opened to Carbide's internal browser. See the following figure for an example:
+
+
You can perform operations by clicking the underlined links in the report:
+
+
Click an item in the API Name, Subsystem, or Libs column to start an API Query with the selected API name, subsystem or library as the search string and a preselected query type.
+
Click an item in the Used headers or Using files column to open the selected file.
+
+
Note: You can only open links from the report when the API Query Carbide.c++ Extension is running.
+
+
+
+
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_for_source_code_identifier.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_for_source_code_identifier.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,35 @@
+
+
+
+
+Running an API query based on the source code identifier
+
+
+
+
+
Running an API query based on the source code identifier
+
A convenient way to run an API query is to start it directly from your source code. You can use any of the following identifier types as criteria:
+
+
Header Name
+
LIB Name
+
CR/P&S Key Name.
+
+
To run a query using an identifier, do the following:
+
+
Select the identifier name or part of the name from the code.
Tip: with the Header Name type, it is enough to place the cursor on a line that has a valid #include directive, or select multiple lines.
+
Right-click the selection and from the pop-up menu, select API Query followed by the identifier type.
+
+
The API Query view is opened, if not already activated, and the selected identifier is copied into the Search string field. The query is carried out automatically and the found matches are displayed in the Search results list.
+
Select the API of your choice from the list to view its details.
The information is retrieved into the API details table.
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_from_context_menu.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_from_context_menu.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,24 @@
+
+
+
+
+Running an API query from the context menu
+
+
+
+
+
Running an API query from the context menu
+
API Query provides a context menu that is visible for Carbide projects both in the C/C++ Projects view, and for header and source files of those projects opened in the editor.
+
From the context menu, you can either run a query based on a specific identifier in the source code (for example, a header name), or you can generate a report of API usage throughout your project. The report is in HTML format, and it summarizes the API names and header files that your project uses.
+
+
+
+
\ No newline at end of file
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_from_search_tab.htm
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery.help/html/tasks/query_from_search_tab.htm Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,43 @@
+
+
+
+
+Running an API query from the Search tab
+
+
+
+
+
Running an API query from the Search tab
+
+
Before you start
+
Make sure you have configured the data source you want to use. For instructions, see Configuring data sources.
+
To run API queries, do the following:
+
+
Select the query type from the Query by group.
Note: a different set of query types may be enabled depending on the configured data source.
+
In the Search string field, enter the string you want to search for.
For example, avkon for an API name or akna for a header name, and so on. For multi search seperate the keyword with "; " character. Wildcard characters (*,?) are not supported.
+
To run the query, click Search.
The list of found APIs are shown in the Search results list, as shown in the example below.
+
Single keyword search
+
+
Multi Keyword search
+
+
+
The ID of the data source is shown in the brackets after the API name. If there are multiple data source entries configured, the same API may be listed once for each data source entry.
+
To view only the API names in the Search results list, check the option Show only API names.
+
Select the API of your choice from the list to view its details.
The information is fetched into the API details table and the value that fulfils the search criteria is highlighted with red, as shown in the example below.
+
+
Headers can be opened by clicking on the link provided in the api details tab.Header is opened in editor/web browser based on the selected data source.If the data source is sdk then it will be opened in editor.If the data source is webserver then it will be opened in s60lxr.
+
Note: the data fields shown in the API details table can vary based on the current data source selection and headerlink will be enabled only when the serach is for header file.
+
+Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+
+This product includes software developed by Eclipse Project.
+http://www.eclipse.org.
+
+
"); //$NON-NLS-1$
+ html.append("\n"); //$NON-NLS-1$
+
+ String [] detailsToReport ;//For API Details
+ //Add all APIs used in project to report
+ for (String api : apis) {
+ html.append("
"); //$NON-NLS-1$
+ //Adding API Name to html. If details for API could not be found, adding name this.UNKNOWN_API_NAME
+ if(!api.startsWith(UNKNOWN_API_NAME + UNKNOWN_API_NAME_SEPARATOR)){
+
+ //Creating link for launching action to run API Query by API Name
+ html.append("" +api +""); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ }
+ //API Is unknown
+ else{
+ html.append(""); //$NON-NLS-1$
+ html.append(UNKNOWN_API_NAME);
+ html.append(""); //$NON-NLS-1$
+ }
+ //Adding API Details to html
+ detailsToReport = getApiDetails(api);
+ for (int i = 0; i < detailsToReport.length; i++) {
+ html.append("
"); //$NON-NLS-1$
+ int searchMethodId = UserSettings.getInstance().getCurrentlySelectedSearchMethod().
+ getQueryTypeByAPIDetailNameInDetails(apiDetailsToReport[i]);
+ //If search method is supported
+ if(searchMethodId != -1
+ && UserSettings.getInstance().getCurrentlySelectedSearchMethod().isSupportedQueryType(searchMethodId)
+ && !detailsToReport[i].equals(HTML_WHITE_SPACE)){
+
+ String comma = ","; //$NON-NLS-1$
+ String [] items = detailsToReport[i].split(comma);
+ for (int j = 0; j < items.length; j++) {
+
+ //Creating link for launching action to run API Query by a type
+ html.append("" +items[j] +""); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ if(j < (items.length-1)){
+ html.append(comma);
+ }
+ }
+
+ }
+ //If current topic is not supported for API Query
+ else{
+ html.append(detailsToReport[i]);
+ }
+ html.append("
\n"); //$NON-NLS-1$
+ }
+
+ html.append("\n
"); //$NON-NLS-1$
+ //Adding "used headers" to html
+ for (String header : tmpVect) {
+ //Creating link for launching action to open file
+ html.append(""); //$NON-NLS-1$ //$NON-NLS-2$
+ html.append(header);
+ html.append(""); //$NON-NLS-1$
+ html.append(" "); //$NON-NLS-1$
+ }
+ html.append("
\n
"); //$NON-NLS-1$
+ Vector usingFileTmpVect = usingFiles.get(api);
+
+ Vector allreadyAdded = new Vector();
+ //Adding "using files" to html
+ for (IFile file : usingFileTmpVect) {
+ //To prevent adding duplicates of same file
+ if(!allreadyAdded.contains(file)){
+ //Creating link for launching action to open file
+ html.append(""); //$NON-NLS-1$ //$NON-NLS-2$
+ html.append(file.getName());
+ html.append(""); //$NON-NLS-1$
+ html.append(" "); //$NON-NLS-1$
+ allreadyAdded.add(file);
+ }
+
+ }
+ html.append("
\n
\n"); //$NON-NLS-1$
+ }
+
+ html.append("
"); //$NON-NLS-1$
+ html.append("\n"); //$NON-NLS-1$
+
+
+ //Add HTML end tags to report
+ html.append(getHTMLEndTags());
+ return html.toString();
+ }
+
+ private String getProjectNameParam(){
+ return "&" +ReportActionConstants.PARAM_PROJECT_NAME +"=" +selectedProject.getName(); //$NON-NLS-1$ //$NON-NLS-2$
+ }
+
+ /**
+ * Get URL for actio Servlet
+ * @return http://[server]:[port]/[servlet]
+ */
+ private String getServletURL(){
+ return "http://" +APIQueryWebServerConfigurator.WEB_SERVER_HOST //$NON-NLS-1$
+ +":" +APIQueryWebServerConfigurator.WEB_SERVER_HTTP_PORT //$NON-NLS-1$
+ +"/" +ReportActionConstants.SERVLET_NAME; //$NON-NLS-1$
+ }
+
+ /**
+ * get API Details to report. Founding API_DETAILS_TO_REPORT keys from
+ * projectUsingAPIDetails by api.
+ * @param api
+ * @return
+ */
+ private String[] getApiDetails(String api){
+ String[] detailsToReport = new String [apiDetailsToReport.length];
+ APIDetails details = projectUsingAPIDetails.get(api);
+ if(details != null){
+ APIDetailField field;
+ for (int i = 0; i < apiDetailsToReport.length; i++) {
+ field = details.getDetail(apiDetailsToReport[i]);
+ //To fill up empty HTML table columns, adding an white space ( )
+ //to detail where is no real data. This looks bettre in UI (HTML report)
+ if(field.getValue() != null && !field.getValue().trim().equals("")){ //$NON-NLS-1$
+ detailsToReport[i] = field.getValue();
+ }
+ //To avoid HTML table different behavior with empty slots, putting a white space to emtpy slots
+ else{
+ detailsToReport[i] = HTML_WHITE_SPACE;
+ }
+ }
+ }
+ else {
+ //To avoid HTML table different behavior with empty slots, putting a white space to emtpy slots
+ for (int i = 0; i < apiDetailsToReport.length; i++) {
+ detailsToReport[i] = HTML_WHITE_SPACE;
+ }
+ }
+ return detailsToReport;
+ }
+
+ /**
+ *
+ * Not implemented.
+ *
+ * Generate report in CSV format.
+ * @return null
+ */
+ public String toCSV() {
+ //Not implemented
+ return null;
+ }
+
+ /**
+ * Writes this.toHTML() to file
+ * @param title
+ * @param fileName
+ */
+ public void toHTMLFile(String title, String fileName ) {
+
+ try {
+ BufferedWriter out = new BufferedWriter(new FileWriter(
+ fileName));
+ out.write(toHTML(title));
+ out.close();
+ } catch (IOException e) {
+ e.printStackTrace();
+ }
+ }
+ /**
+ *
+ * Not implemented until {@link #toCSV()} is implemented.
+ *
+ * Writes this.toCSV() to file
+ * @param title
+ * @param fileName
+ */
+ public void toCSVFile(String title, String fileName ) {
+
+ try {
+ BufferedWriter out = new BufferedWriter(new FileWriter(
+ fileName));
+ out.write(toCSV());
+ out.close();
+ } catch (IOException e) {
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ * generating html header and opening body and adding title to it
+ * @param title
+ * @return
+ */
+ private StringBuffer getHTMLHeader(String title){
+ StringBuffer b = new StringBuffer();
+ b.append(""); //$NON-NLS-1$
+ b.append(title);
+ b.append("\n"); //$NON-NLS-1$
+ b.append(getHTMLStyles());
+
+ b.append("\n\n"); //$NON-NLS-1$
+ b.append("
"); //$NON-NLS-1$
+ b.append(title);
+ b.append("
\n"); //$NON-NLS-1$
+ return b;
+ }
+ /**
+ * get body and html end tags
+ * @return
+ */
+ private StringBuffer getHTMLEndTags(){
+ StringBuffer b = new StringBuffer();
+ b.append(""); //$NON-NLS-1$
+ return b;
+ }
+ /**
+ * get HTML style sheet
+ * @return styles
+ */
+ private StringBuffer getHTMLStyles(){
+
+ String cssPath = null;
+
+ try {
+ //Get location for stylesheet file
+ cssPath = APIQueryPlugin.getDefault().getPluginInstallPath() +
+ File.separatorChar + ProductInfoRegistry.getResourcesRelativePath()
+ +File.separatorChar + ProductInfoRegistry.getReportCSSFileName();
+ //return contents of the stylesheet file
+ return FileUtils.loadDataFromFile(cssPath);
+ } catch (Exception e) {
+ //FileNotFoundException or IOException may occur
+ e.printStackTrace();
+ APIQueryConsole.getInstance().println(
+ Messages.getString("CheckProjectReport.UnableToLoadCSS_Part1_ErrMsg") +cssPath +Messages.getString("CheckProjectReport.UnableToLoadCSS_Part2_ErrMsg") +e, //$NON-NLS-1$ //$NON-NLS-2$
+ APIQueryConsole.MSG_ERROR);
+ //If there was an error, returning dummy (hard coded) styles
+ return getDummyCSS();
+ }
+
+ }
+
+ /**
+ * If there is something wrong, hard coded styles can be used
+ * @return dummy styles
+ */
+ private StringBuffer getDummyCSS() {
+ StringBuffer b = new StringBuffer();
+ b.append(""); //$NON-NLS-1$
+ return b;
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/popup/actions/OpenFileAction.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/popup/actions/OpenFileAction.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,410 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+package com.nokia.s60tools.apiquery.popup.actions;
+
+import java.io.File;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Vector;
+
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IFolder;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.core.runtime.jobs.IJobChangeEvent;
+import org.eclipse.core.runtime.jobs.IJobChangeListener;
+import org.eclipse.core.runtime.jobs.Job;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.ui.IEditorDescriptor;
+import org.eclipse.ui.IEditorRegistry;
+import org.eclipse.ui.IWorkbench;
+import org.eclipse.ui.IWorkbenchPage;
+import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.ide.IDE;
+
+import com.nokia.carbide.cdt.builder.CarbideBuilderPlugin;
+import com.nokia.carbide.cdt.builder.EpocEngineHelper;
+import com.nokia.carbide.cdt.builder.ICarbideBuildManager;
+import com.nokia.carbide.cdt.builder.project.ICarbideBuildConfiguration;
+import com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo;
+import com.nokia.s60tools.apiquery.shared.exceptions.QueryOperationFailedException;
+import com.nokia.s60tools.apiquery.shared.job.FindFileFromFoldersJob;
+import com.nokia.s60tools.apiquery.shared.plugin.APIQueryPlugin;
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.ui.dialogs.APIQueryMessageBox;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+
+/**
+ * Action class for find and then open wanted file to Editor area.
+ * File can be seeked under SDK include paths or
+ * under given project in Carbides Workspace.
+ */
+public class OpenFileAction implements IJobChangeListener{
+
+ /**
+ * Current default build configuration SDK ID.
+ */
+ private String sdkUniqueId = null;
+ private String fileName = null;
+ private String projectName;
+
+ /**
+ * Opens file from given project in Carbide workspace.
+ * @param fileName
+ * @param projectName
+ */
+ public void openFileFromProject(String fileName, String projectName) {
+
+ this.fileName = fileName;
+ this.projectName = projectName;
+ try {
+
+ APIQueryConsole.getInstance().println(Messages.getString("OpenFileAction.StartingSeek_Msg_Part1") +fileName +Messages.getString("OpenFileAction.StartingSeek_Msg_Part2") +projectName +"'"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+
+ IProject project = getProject(projectName);
+
+ IResource[] members = project.members();
+
+ Vector files = getMatchingResources(fileName, members);
+
+ if(!files.isEmpty()){
+
+ //It should not be possible that there is multiple foundings for resource, because path is added when file was seeked
+ IResource res = files.get(0);
+ IPath path = res.getFullPath();
+ URI uri = res.getLocationURI();
+ openFile(uri, path.lastSegment());
+ }else{
+ String message = Messages.getString("OpenFileAction.CannotFoundFile_ErrMsg_Part1") +fileName +Messages.getString("OpenFileAction.CannotFoundFile_ErrMsg_Part2") +projectName +"'."; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ showErrorMessage(message);
+
+ }
+
+ } catch (Exception e) {
+ showUnexpectedErrorMsg(e);
+ }
+
+ }
+
+
+ /**
+ * Logs and shows error message for unexpected error situations.
+ * @param fileName
+ * @param projectName
+ * @param e {@link Exception}
+ */
+ private void showUnexpectedErrorMsg(Exception e) {
+ e.printStackTrace();
+ String msg = Messages.getString("OpenFileAction.Unexpected_ErrMsg_Part1")+fileName +Messages.getString("OpenFileAction.Unexpected_ErrMsg_Part2") +projectName +"'."; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ String consoleMsg = msg +Messages.getString("OpenFileAction.Unexpected_ErrMsg_Part3") +e; //$NON-NLS-1$
+ APIQueryConsole.getInstance().println(consoleMsg, APIQueryConsole.MSG_ERROR);
+ showErrorMessage(msg);
+ }
+
+
+
+ /**
+ * Show an error message to user and logs same message to console.
+ * @param message
+ */
+ private void showErrorMessage(final String message) {
+ APIQueryConsole.getInstance().println(message, APIQueryConsole.MSG_ERROR);
+ Runnable run = new Runnable(){
+ public void run(){
+ new APIQueryMessageBox(message,
+ SWT.ICON_ERROR | SWT.OK).open();
+
+ }
+ };
+ Display.getDefault().asyncExec(run);
+ }
+
+
+
+ /**
+ * Check recursively all folders inside given resources and seeks give file
+ * @param fileName
+ * @param members
+ * @return resources found
+ * @throws CoreException
+ */
+ private Vector getMatchingResources(String fileName,
+ IResource[] members) throws CoreException {
+ Vector files = new Vector();
+
+ for (int i = 0; i < members.length; i++) {
+ IResource res = members[i];
+ //If resource is folder, seeking all folders and files under it
+ if (res instanceof IFolder) {
+ IFolder fold = (IFolder) res;
+ IResource[] folderMembers = fold.members();
+ files.addAll(getMatchingResources(fileName, folderMembers));
+ }
+ //If resource is file, checking if thats file we are interest of
+ else if (res instanceof IFile) {
+
+ String name = res.getName();
+ //If file name match to resource name adding to
+ if (fileName.equalsIgnoreCase(name)) {
+ files.add(res);
+ }else if(fileName.equalsIgnoreCase(res.getProjectRelativePath().toOSString())){
+ files.add(res);
+ }
+ }
+ //Else we have no interest of resource
+ }
+ return files;
+ }
+
+ /**
+ * Open file given to Editor area.
+ * @param uri
+ * @param fileName
+ */
+ public void openFile(final URI uri, final String fileName) {
+
+ //Runnable to open new file
+ final Runnable runOpen = new Runnable() {
+ public void run() {
+ // do the actual work in here
+
+ try {
+ IWorkbench workbench = PlatformUI.getWorkbench();
+ IWorkbenchPage page = APIQueryPlugin.getCurrentlyActivePage();
+ //Find default editor for that file
+ IEditorRegistry reg = workbench.getEditorRegistry();
+ IEditorDescriptor editor = reg.getDefaultEditor(fileName);
+ //We open editor by it's ID
+ final String editorId = editor.getId();
+ //Opening file in editor
+ IDE.openEditor(page, uri, editorId, true);
+
+ } catch (Exception e) {
+ showUnexpectedErrorMsg(e);
+ }
+
+ }
+ };
+ Display.getDefault().asyncExec(runOpen);
+ }
+
+
+ /**
+ * Open file to Editor area
+ * @param file
+ * @throws URISyntaxException
+ */
+ private void openFile(File file) throws URISyntaxException {
+ String path = file.getAbsolutePath();
+ String uriStr = path.replace("\\", "/");; //$NON-NLS-1$ //$NON-NLS-2$
+ uriStr = "file://" + uriStr; //$NON-NLS-1$
+ URI uri = new URI(uriStr);
+ openFile(uri, file.getName());
+ }
+
+ /**
+ * Opens file from SDK. Projects default build configuration is used as SDK,
+ * MMP files from that project is seeked, and file is seeked under inc paths found in
+ * MMP files.
+ *
+ * File is opened or error message is shown when done.
+ *
+ * @param fileName
+ * @param projectName
+ */
+ public void openFileFromSDK(String fileName, String projectName) {
+
+ this.fileName = fileName;
+ this.projectName = projectName;
+ try {
+ //Get project by name
+ IProject project = getProject(projectName);
+ //Gets Include paths for project. Header files must be found from includepaths.
+ List paths = getIncludePaths(project);
+ APIQueryConsole.getInstance().println(
+ Messages.getString("OpenFileAction.TargetFound_Msg_Part1") +sdkUniqueId //$NON-NLS-1$
+ +Messages.getString("OpenFileAction.TargetFound_Msg_Part2") +projectName //$NON-NLS-1$
+ +Messages.getString("OpenFileAction.TargetFound_Msg_Part3") +fileName +"'."); //$NON-NLS-1$ //$NON-NLS-2$
+
+ //Seeking paths where file(s) are found
+ //it will happened asynchronously, and when done, file will be opened.
+ findFiles(fileName, paths);
+
+ } catch (QueryOperationFailedException e) {
+ showErrorMessage(e.getMessage());
+ }catch (Exception e) {
+ showUnexpectedErrorMsg(e);
+ }
+
+
+ }
+
+
+ /**
+ * Get include paths for project
+ * @param project
+ * @return absolutely include paths for project, found in MMP files.
+ * @throws QueryOperationFailedException
+ */
+ private List getIncludePaths(IProject project) throws QueryOperationFailedException {
+ List paths = new ArrayList();
+
+ ICarbideBuildManager buildMgr = CarbideBuilderPlugin.getBuildManager();
+ ICarbideProjectInfo cpi = null;
+ if (buildMgr.isCarbideProject(project)){
+ // check to make sure this is a Carbide project
+ cpi = buildMgr.getProjectInfo(project);
+ // Get the default build configuration
+ ICarbideBuildConfiguration defaultConfig = cpi.getDefaultConfiguration();
+ sdkUniqueId = defaultConfig.getSDK().getUniqueId();
+
+ List _userPaths = new ArrayList();
+ List _systemPaths = new ArrayList();
+ EpocEngineHelper.getProjectIncludePaths(cpi, defaultConfig, _userPaths, _systemPaths) ;
+ paths.addAll(_userPaths);
+ paths.addAll(_systemPaths);
+ }
+ else{
+ throw new QueryOperationFailedException(Messages.getString("OpenFileAction.NotCarbideProject_ErrMsg_Part1") +projectName +Messages.getString("OpenFileAction.NotCarbideProject_ErrMsg_Part2")); //$NON-NLS-1$ //$NON-NLS-2$
+ }
+
+
+ return paths;
+ }
+
+ /**
+ * Get project by name.
+ * @param projectName
+ * @return project
+ * @throws CoreException
+ * @throws QueryOperationFailedException
+ */
+ private IProject getProject(String projectName) throws CoreException, QueryOperationFailedException {
+ IProject prj = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);
+ if(!prj.exists()){
+ throw new QueryOperationFailedException (Messages.getString("OpenFileAction.ProjectNotExist_ErrMsg_Part1") +projectName +Messages.getString("OpenFileAction.ProjectNotExist_ErrMsg_Part2")); //$NON-NLS-1$ //$NON-NLS-2$
+ }
+ if(!prj.isOpen()){
+ //If project is closed, just opening it before returning
+ prj.open(new NullProgressMonitor());
+ }
+ prj.getWorkspace();
+ return prj;
+ }
+
+
+
+ /**
+ * Find file under folders given
+ * @param fileName
+ * @param includePaths
+ */
+ private void findFiles(String fileName, List includePaths) {
+ // System.out.println(Messages.getString("OpenFileAction.18")); //$NON-NLS-1$
+ FindFileFromFoldersJob job = new FindFileFromFoldersJob(Messages.getString("OpenFileAction.JobName_Msg") +fileName, includePaths, fileName, sdkUniqueId); //$NON-NLS-1$
+ job.setPriority(Job.DECORATE);
+ //Listener will be called when seeking is done
+ job.addJobChangeListener(this);
+ job.schedule();
+
+ }
+
+
+
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.jobs.IJobChangeListener#done(org.eclipse.core.runtime.jobs.IJobChangeEvent)
+ */
+ public void done(IJobChangeEvent event) {
+
+ //
+ // When job is done, this will be called, and found file will be opened
+
+ try {
+ FindFileFromFoldersJob job = (FindFileFromFoldersJob) event
+ .getJob();
+ Collection files = job.getFoundSourceFiles();
+
+ if (files.isEmpty()) {
+ String message = Messages.getString("OpenFileAction.CannotFoundFile_Msg_Part1") + fileName //$NON-NLS-1$
+ + Messages.getString("OpenFileAction.CannotFoundFile_Msg_Part2") + sdkUniqueId //$NON-NLS-1$
+ + "'."; //$NON-NLS-1$
+ showErrorMessage(message);
+ }
+ //Else we just open first file that we found
+ else{
+ File file = ((File[]) files.toArray(new File[0]))[0];
+ openFile(file);
+ }
+ } catch (Exception e) {
+ showUnexpectedErrorMsg(e);
+ }
+
+ }
+
+
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.jobs.IJobChangeListener#aboutToRun(org.eclipse.core.runtime.jobs.IJobChangeEvent)
+ */
+ public void aboutToRun(IJobChangeEvent event) {
+ //Not needed
+ }
+
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.jobs.IJobChangeListener#awake(org.eclipse.core.runtime.jobs.IJobChangeEvent)
+ */
+ public void awake(IJobChangeEvent event) {
+ //Not needed
+
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.jobs.IJobChangeListener#running(org.eclipse.core.runtime.jobs.IJobChangeEvent)
+ */
+ public void running(IJobChangeEvent event) {
+ //Not needed
+ }
+
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.jobs.IJobChangeListener#scheduled(org.eclipse.core.runtime.jobs.IJobChangeEvent)
+ */
+ public void scheduled(IJobChangeEvent event) {
+ //Not needed
+ }
+
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.jobs.IJobChangeListener#sleeping(org.eclipse.core.runtime.jobs.IJobChangeEvent)
+ */
+ public void sleeping(IJobChangeEvent event) {
+ //Not needed
+ }
+
+
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/popup/actions/QueryErrorInfo.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/popup/actions/QueryErrorInfo.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,48 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.popup.actions;
+
+/**
+ * Simple class for storing error information returned query operations.
+ * This is needed because queries are runned inside a runnable and
+ * error info is got via try/catch, and the error information usage
+ * related needs to be done outside runnable where catch is made.
+ * This class should stay with package private visibility.
+ */
+class QueryErrorInfo{
+ /**
+ * Error description is set on failure.
+ */
+ private String errorDescription = new String();
+
+ /**
+ * Gets error description.
+ * @return the errorDescription
+ */
+ public String getErrorDescription() {
+ return errorDescription;
+ }
+
+ /**
+ * Sets error description.
+ * @param errorDescription the errorDescription to set
+ */
+ public void setErrorDescription(String errorDescription) {
+ this.errorDescription = errorDescription;
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/servlets/APIQueryWebServerConfigurator.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/servlets/APIQueryWebServerConfigurator.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,169 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+package com.nokia.s60tools.apiquery.servlets;
+
+import java.io.IOException;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.util.Hashtable;
+
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.equinox.http.jetty.JettyConfigurator;
+import org.eclipse.equinox.http.jetty.JettyConstants;
+import org.eclipse.jface.dialogs.MessageDialog;
+import org.eclipse.swt.widgets.Display;
+import org.osgi.framework.Bundle;
+
+import com.nokia.s60tools.apiquery.shared.plugin.APIQueryPlugin;
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+/**
+ * Class for handling API Query Web server functionalities. E.g. start and stop Web Server.
+ */
+public class APIQueryWebServerConfigurator {
+
+ /**
+ * Host where report server is running (localhost)
+ */
+ public static final String WEB_SERVER_HOST = "localhost"; //$NON-NLS-1$
+
+ /**
+ * HTTP port to be used with running HTTP server
+ */
+ public static final int WEB_SERVER_HTTP_PORT = 4191;
+
+ /**
+ * Name of the API Query Web Server
+ */
+ private static final String API_QUERY_WEB_SERVER_NAME = "API Query Server"; //$NON-NLS-1$
+
+ /**
+ *
+ */
+public static final int Active_Project_Start = 0;
+
+public static final int Carbide_Instance_start =1;
+
+static boolean activeProjectStartedServer = false;
+
+
+ /**
+ * Starts API Query Web Server. Web Server is used for launch actions in HTML report.
+ * Reports are created with Export report functionality (API Query for Active project).
+ * @see JettyConfigurator#startServer(String, java.util.Dictionary)
+ */
+public static void startServer(int msgdialogueCode) {
+ try {
+
+ if (msgdialogueCode == Active_Project_Start) activeProjectStartedServer = true;
+ // Check if server is already running
+ if (allreadyRunning()) {
+ //Show the dialogue box
+
+ if (msgdialogueCode==Carbide_Instance_start && APIQueryPlugin.isFirstLaunch&&!activeProjectStartedServer)
+ {
+ APIQueryPlugin.isFirstLaunch = false;
+ MessageDialog.openInformation(APIQueryPlugin.getCurrentlyActiveWbWindowShell(), "APIQuery Plugin: Active Project Option Information", "Active project report links may not work. Close other Carbide.C++ instances and restart API Query plug-in.");
+ }
+ return;
+ }
+
+ Hashtable set = new Hashtable();
+ set.put(JettyConstants.HTTP_PORT, WEB_SERVER_HTTP_PORT);
+ JettyConfigurator.startServer(API_QUERY_WEB_SERVER_NAME, set);
+
+ Bundle bundle = Platform
+ .getBundle("org.eclipse.equinox.http.registry"); //$NON-NLS-1$
+
+ if (bundle.getState() == Bundle.RESOLVED) {
+ bundle.start(Bundle.START_TRANSIENT);
+ }
+ APIQueryConsole
+ .getInstance()
+ .println(
+ Messages
+ .getString("APIQueryWebServerConfigurator.StartServer_Msg_Part1")//$NON-NLS-1$
+ + API_QUERY_WEB_SERVER_NAME
+ + Messages
+ .getString("APIQueryWebServerConfigurator.StartServer_Msg_Part2")//$NON-NLS-1$
+ + "http://" + WEB_SERVER_HOST + ":" + WEB_SERVER_HTTP_PORT //$NON-NLS-1$ //$NON-NLS-2$
+ + Messages
+ .getString("APIQueryWebServerConfigurator.StartServer_Msg_Part3")); //$NON-NLS-1$
+
+ } catch (Exception e) {
+ e.printStackTrace();
+ APIQueryConsole
+ .getInstance()
+ .println(
+ Messages
+ .getString("APIQueryWebServerConfigurator.StartServer_ErrMsg_Part1") + API_QUERY_WEB_SERVER_NAME + Messages.getString("APIQueryWebServerConfigurator.StartServer_ErrMsg_Part2") + e, APIQueryConsole.MSG_ERROR); //$NON-NLS-1$ //$NON-NLS-2$
+
+ }
+ }
+
+
+
+ /**
+ * Check if HTTP Server is already running
+ * @return true if server is alreaydy running and false if not.
+ */
+ private static boolean allreadyRunning() {
+
+
+ try {
+ //Servlet URL
+ String servletURL = "http://" +WEB_SERVER_HOST +":" +WEB_SERVER_HTTP_PORT + "/" + ReportActionConstants.SERVLET_NAME;
+ URL url = new URL(servletURL);
+ //Try to keep http connection alive
+ System.setProperty("http.keepAlive", "true");
+
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION, "-----> Reading URL: " + url.toString());
+ //Getting connection to check if server is running
+ HttpURLConnection con = (HttpURLConnection) url.openConnection();
+ if (con.getResponseCode() == HttpURLConnection.HTTP_OK) {
+ return true;
+ }
+
+ } catch (IOException e) {
+ // IOExeption occurs if HttpURLConnection is not alive
+ //and when HttpURLConnection.getResponseCode() is called
+ //then we know that HTTP server is not up and running
+ }
+ catch (Exception e) {
+ //No operation if something else happens, just returning false
+ }
+
+ return false;
+ }
+
+ /**
+ * Stops API Query Web Server.
+ * @see JettyConfigurator#stopServer(String)
+ */
+ public static void stopServer(){
+ try {
+ JettyConfigurator.stopServer(API_QUERY_WEB_SERVER_NAME);
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryWebServerConfigurator.StoptServer_Msg_Part1") +API_QUERY_WEB_SERVER_NAME +Messages.getString("APIQueryWebServerConfigurator.StoptServer_Msg_Part2")); //$NON-NLS-1$ //$NON-NLS-2$
+ } catch (Exception e) {
+ e.printStackTrace();
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryWebServerConfigurator.StoptServer_ErrMsg_Part1") +API_QUERY_WEB_SERVER_NAME +Messages.getString("APIQueryWebServerConfigurator.StoptServer_ErrMsg_Part2") +e, APIQueryConsole.MSG_ERROR); //$NON-NLS-1$ //$NON-NLS-2$
+ }
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/servlets/ReportActionConstants.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/servlets/ReportActionConstants.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,57 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+package com.nokia.s60tools.apiquery.servlets;
+
+
+/**
+ * Constants for {@link ReportActionServlet} and relative classes.
+ */
+public class ReportActionConstants {
+
+
+ /**
+ * Servlet name taking action request and forwards it to actions
+ */
+ public static final String SERVLET_NAME = "reportAction"; //$NON-NLS-1$
+
+ /**
+ * Parameter name for API Query For
+ */
+ public static final String PARAM_QUERY_FOR = "apiQueryFor"; //$NON-NLS-1$
+
+ /**
+ * Parameter name for API Query Type
+ */
+ public static final String ACTION_QUERY_TYPE = "apiQueryType"; //$NON-NLS-1$
+
+ /**
+ * Parameter name for Open Used Header
+ */
+ public static final String ACTION_OPEN_USED_HEADER = "openUsedHeader"; //$NON-NLS-1$
+
+ /**
+ * Parameter name for Open Using File
+ */
+ public static final String ACTION_OPEN_USING_FILE = "openUsingFile"; //$NON-NLS-1$
+
+ /**
+ * Name of the project what report stands for
+ */
+ public static final String PARAM_PROJECT_NAME = "projectName"; //$NON-NLS-1$
+
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/servlets/ReportActionServlet.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/servlets/ReportActionServlet.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,194 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+package com.nokia.s60tools.apiquery.servlets;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+
+import javax.servlet.Servlet;
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.widgets.Display;
+
+import com.nokia.s60tools.apiquery.popup.actions.CheckIdentifierAction;
+import com.nokia.s60tools.apiquery.popup.actions.OpenFileAction;
+import com.nokia.s60tools.apiquery.settings.UserSettings;
+import com.nokia.s60tools.apiquery.shared.exceptions.QueryOperationFailedException;
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension;
+import com.nokia.s60tools.apiquery.shared.ui.dialogs.APIQueryMessageBox;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.apiquery.ui.views.main.MainView;
+
+/**
+ * Servlet that takes request from API Query report and forwards it to action.
+ * Web Server inside Carbide must be up and running when Servlet is executed.
+ *
+ * The Web server is running when API Query {@link MainView} is alive.
+ *
+ * @see APIQueryWebServerConfigurator#startServer()
+ */
+public class ReportActionServlet extends HttpServlet implements Servlet {
+
+
+ /**
+ * Default ID.
+ */
+ private static final long serialVersionUID = 1L;
+
+
+
+ /* (non-Javadoc)
+ * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
+ */
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp)
+ throws ServletException, IOException {
+
+ String queryType = req.getParameter(ReportActionConstants.ACTION_QUERY_TYPE);
+ try {
+ String projectName;
+ if(req.getParameter(ReportActionConstants.ACTION_QUERY_TYPE) != null){
+ int type = 1;
+ if(queryType != null){
+ type = Integer.parseInt(queryType);
+ }
+ String searchString = (String) req.getParameter(ReportActionConstants.PARAM_QUERY_FOR);
+ runAPIQueryFor(searchString, type);
+ }
+ else if(req.getParameter(ReportActionConstants.ACTION_OPEN_USED_HEADER) != null){
+ String headerName = (String) req.getParameter(ReportActionConstants.ACTION_OPEN_USED_HEADER);
+ projectName = (String) req.getParameter(ReportActionConstants.PARAM_PROJECT_NAME);
+ openFileFromSDK(headerName, projectName);
+ }
+ else if(req.getParameter(ReportActionConstants.ACTION_OPEN_USING_FILE) != null){
+ String fileName = (String) req.getParameter(ReportActionConstants.ACTION_OPEN_USING_FILE);
+ projectName = (String) req.getParameter(ReportActionConstants.PARAM_PROJECT_NAME);
+ openFileFromProject(fileName, projectName);
+ }
+ else{
+ String msg = Messages.getString("ReportActionServlet.NotSupportedAction_Msg"); //$NON-NLS-1$
+ APIQueryConsole.getInstance().println(msg);
+ }
+
+
+ PrintWriter out = resp.getWriter();
+ //When actual servlet page is loaded (Action is launched) directing user back where come from
+ //by loading java script on body load.
+ out.println("\n" + //$NON-NLS-1$
+ "\n" + //$NON-NLS-1$
+ "\n" + //$NON-NLS-1$
+ "\n" + //$NON-NLS-1$
+ ""); //$NON-NLS-1$
+ } catch (NumberFormatException e) {
+ String msg = Messages.getString("ReportActionServlet.NotSupportedQueryType_ErrMsg_Part1") +queryType +Messages.getString("ReportActionServlet.NotSupportedQueryType_ErrMsg_Part2"); //$NON-NLS-1$ //$NON-NLS-2$
+ APIQueryConsole.getInstance().println(msg, APIQueryConsole.MSG_ERROR);
+ e.printStackTrace();
+ } catch (QueryOperationFailedException e) {
+ showErrorMessage(e.getMessage());
+ }
+
+ }
+
+ /**
+ * Shows on error message to user.
+ * @param message
+ */
+ private void showErrorMessage(final String message) {
+ Runnable run = new Runnable(){
+ public void run(){
+ new APIQueryMessageBox(message,
+ SWT.ICON_ERROR | SWT.OK).open();
+
+ }
+ };
+ Display.getDefault().asyncExec(run);
+ }
+
+
+ /**
+ * Open File from project
+ * @param fileName
+ * @param projectName
+ */
+ private void openFileFromProject(String fileName, String projectName) {
+ OpenFileAction action = new OpenFileAction();
+ action.openFileFromProject(fileName, projectName);
+ }
+
+ /**
+ * Open file from SDK
+ * @param fileName
+ * @param projectName
+ */
+ private void openFileFromSDK(String fileName, String projectName) {
+ OpenFileAction action = new OpenFileAction();
+ action.openFileFromSDK(fileName, projectName);
+ }
+
+
+
+ /**
+ * Runs API Query for selected String with selected type
+ * @param searchString String to search for
+ * @param type API Query type
+ * @throws QueryOperationFailedException
+ */
+ private void runAPIQueryFor(final String searchString, final int type) throws QueryOperationFailedException{
+
+ ISearchMethodExtension currentlySelectedSearchMethod = UserSettings.getInstance().getCurrentlySelectedSearchMethod();
+
+ //Check if search method is supported for selected type. Cannot really occur until
+ //some data source is giving API Query report details for API that some other Data source is not supporting
+ //and report is generated with different Data source that is currently in use.
+ boolean isSupported = currentlySelectedSearchMethod.isSupportedQueryType(type);
+ if(!isSupported){
+ String msg = Messages.getString("ReportActionServlet.NotSupportedSearchMethod_ErrMsg_Part1") //$NON-NLS-1$
+ + currentlySelectedSearchMethod.getAPIDetailNameInDetailsByQueryType(type)
+ +Messages.getString("ReportActionServlet.NotSupportedSearchMethod_ErrMsg_Part2") //$NON-NLS-1$
+ + currentlySelectedSearchMethod.getExtensionInfo().getDescription()
+ +"'."; //$NON-NLS-1$
+ APIQueryConsole.getInstance().println(msg, APIQueryConsole.MSG_ERROR);
+ throw new QueryOperationFailedException(
+ msg);
+ }
+
+
+ //Runnable to run API Query action
+ final Runnable run = new Runnable() {
+ public void run() {
+ // do the actual work in here
+ try {
+ CheckIdentifierAction act = new CheckIdentifierAction();
+ act.runAPIQuery(searchString, type);
+ } catch (Exception e) {
+ e.printStackTrace();
+ String msg = Messages.getString("ReportActionServlet.Unexpected_ErrMsg_Part1") //$NON-NLS-1$
+ + searchString +Messages.getString("ReportActionServlet.Unexpected_ErrMsg_Part2") +type +Messages.getString("ReportActionServlet.Unexpected_ErrMsg_Part3") +e; //$NON-NLS-1$ //$NON-NLS-2$
+ APIQueryConsole.getInstance().println(msg, APIQueryConsole.MSG_ERROR);
+ }
+
+ }
+ };
+ Display.getDefault().asyncExec(run);
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/settings/IUserSettingsListener.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/settings/IUserSettingsListener.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,31 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.settings;
+
+/**
+ * Interface for the listeners that want to get user setting modifications events.
+ */
+public interface IUserSettingsListener {
+
+ /**
+ * Notifies the listener that user settings have changed.
+ */
+ public void userSettingsChanged();
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/settings/UserSettings.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/settings/UserSettings.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,127 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.settings;
+
+import java.util.ArrayList;
+
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtensionInfo;
+import com.nokia.s60tools.apiquery.shared.searchmethodregistry.SearchMethodExtensionRegistry;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+
+
+
+/**
+ * Singleton class that is created on plugin
+ * startup, and is kept active as long as plugin is active.
+ *
+ * The purpose of this class is store run-time instance
+ * of active user settings.
+ */
+public class UserSettings {
+
+ /**
+ * Singleton instance.
+ */
+ static private UserSettings instance = null;
+
+ /**
+ * Currently selected search method.
+ */
+ private ISearchMethodExtensionInfo currentlySelectedSearchMethodInfo = null;
+
+ /**
+ * Listeners that can be attached for listening the changes in the user settings.
+ */
+ private ArrayList settingsListeners = new ArrayList();
+
+ /**
+ * Public Singleton instance accessor.
+ * @return Returns instance of this singleton class-
+ */
+ public static UserSettings getInstance(){
+ if( instance == null ){
+ instance = new UserSettings();
+ }
+ return instance;
+ }
+
+ /**
+ * Private default constructor.
+ */
+ private UserSettings() {
+ DbgUtility.println(DbgUtility.PRIORITY_CLASS, "-- <> --> " + getClass().getName()); //$NON-NLS-1$
+ }
+
+ /**
+ * Gets the search method that is currently selected by user.
+ * @return Returns the currentlySelectedSearchMethodInfo, or
+ * null if not set.
+ */
+ public ISearchMethodExtensionInfo getCurrentlySelectedSearchMethodInfo() {
+ return currentlySelectedSearchMethodInfo;
+ }
+
+ /**
+ * Gets the currently selected search method.
+ * @return The currently selected search method.
+ */
+ public ISearchMethodExtension getCurrentlySelectedSearchMethod() {
+ ISearchMethodExtensionInfo currSelExtInfo = getInstance().getCurrentlySelectedSearchMethodInfo();
+ String id = currSelExtInfo.getId();
+ ISearchMethodExtension currSelExt = SearchMethodExtensionRegistry.getInstance().getById(id);
+ return currSelExt;
+ }
+
+ /**
+ * Sets the search method that is currently selected by user.
+ * @param currentlySelectedSearchMethodInfo The currentlySelectedSearchMethodInfo to set.
+ */
+ public void setCurrentlySelectedSearchMethodInfo(
+ ISearchMethodExtensionInfo currentlySelectedSearchMethodInfo) {
+ this.currentlySelectedSearchMethodInfo = currentlySelectedSearchMethodInfo;
+ settingsChanged();
+ }
+
+ /**
+ * Adds a user settings listener.
+ * @param listener Setting listener to add.
+ */
+ public void addUserSettingListener(IUserSettingsListener listener){
+ settingsListeners.add(listener);
+ }
+
+ /**
+ * Removes a user settings listener.
+ * @param listener Setting listener to remove.
+ */
+ public void removeUserSettingListener(IUserSettingsListener listener){
+ settingsListeners.remove(listener);
+ }
+
+ /**
+ * Notifies listeners that the settings has been changed.
+ */
+ public void settingsChanged(){
+ for (IUserSettingsListener listener : settingsListeners) {
+ listener.userSettingsChanged();
+ }
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/common/Product.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/common/Product.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,45 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.common;
+
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+
+/**
+ * Class for getting properties from product.properties file, located in same package.
+ */
+public class Product {
+ private static final String BUNDLE_NAME = "com.nokia.s60tools.apiquery.shared.common.product"; //$NON-NLS-1$
+
+ private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
+ .getBundle(BUNDLE_NAME);
+
+ private Product() {
+ }
+ /**
+ * @param key to product.properties -file
+ * @return a String from product.properties -file
+ */
+ public static String getString(String key) {
+ try {
+ return RESOURCE_BUNDLE.getString(key);
+ } catch (MissingResourceException e) {
+ return '!' + key + '!';
+ }
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/common/ProductInfoRegistry.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/common/ProductInfoRegistry.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,65 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.common;
+
+/**
+ * This class stores product information such as product name,
+ * version, console view name etc.
+ * The idea is to have the product information in one place.
+ */
+public class ProductInfoRegistry {
+
+ private static final String PRODUCT_NAME = Product.getString("ProductInfoRegistry.Product_Name"); //$NON-NLS-1$
+ private static final String CONSOLE_WINDOW_NAME = PRODUCT_NAME + " " + Product.getString("ProductInfoRegistry.Console_Window_Name_Postfix"); //$NON-NLS-1$ //$NON-NLS-2$
+ private static final String IMAGES_DIRECTORY = Product.getString("ProductInfoRegistry.Images_Directory"); //$NON-NLS-1$
+ private static final String RESOURCES_RELATIVE_PATH = Product.getString("ProductInfoRegistry.Resources_Relative_Path"); //$NON-NLS-1$
+ private static final String REPORT_CSS_FILE_NAME = Product.getString("ProductInfoRegistry.report_css_File_Name"); //$NON-NLS-1$
+
+ /**
+ * @return Returns the CONSOLE_WINDOW_NAME.
+ */
+ public static String getConsoleWindowName() {
+ return CONSOLE_WINDOW_NAME;
+ }
+ /**
+ * @return Returns the PRODUCT_NAME.
+ */
+ public static String getProductName() {
+ return PRODUCT_NAME;
+ }
+
+ /**
+ * @return Returns the IMAGES_DIRECTORY.
+ */
+ public static String getImagesDirectoryName() {
+ return IMAGES_DIRECTORY;
+ }
+ /**
+ * @return Returns the RESOURCES_RELATIVE_PATH.
+ */
+ public static String getResourcesRelativePath() {
+ return RESOURCES_RELATIVE_PATH;
+ }
+ /**
+ * @return Returns the REPORT_CSS_FILE_NAME.
+ */
+ public static String getReportCSSFileName() {
+ return REPORT_CSS_FILE_NAME;
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/common/product.properties
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/common/product.properties Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,22 @@
+#
+# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+# All rights reserved.
+# This component and the accompanying materials are made available
+# under the terms of "Eclipse Public License v1.0"
+# which accompanies this distribution, and is available
+# at the URL "http://www.eclipse.org/legal/epl-v10.html".
+#
+# Initial Contributors:
+# Nokia Corporation - initial contribution.
+#
+# Contributors:
+#
+# Description:
+#
+#
+
+ProductInfoRegistry.Product_Name=API Query
+ProductInfoRegistry.Console_Window_Name_Postfix=Console
+ProductInfoRegistry.Images_Directory=icons
+ProductInfoRegistry.Resources_Relative_Path=resources
+ProductInfoRegistry.report_css_File_Name=htmlReportStyles.css
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIDetailField.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIDetailField.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,72 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+/**
+ * Stores a single field of information
+ * for API details.
+ */
+public class APIDetailField {
+
+ public static final String VALUE_FIELD_SEPARATOR = ", "; //$NON-NLS-1$
+
+ /**
+ * Description for the detail field.
+ */
+ private final String description;
+ /**
+ * Value for the detail field.
+ */
+ private String value;
+
+ /**
+ * Constructor.
+ * @param description Description for the detail field.
+ * @param value Value for the detail field.
+ */
+ public APIDetailField(String description, String value){
+ this.description = description;
+ this.value = value;
+
+ }
+
+ /**
+ * Gets the description of the field.
+ * @return the description
+ */
+ public String getDescription() {
+ return description;
+ }
+
+ /**
+ * Gets the value of the field.
+ * @return the value
+ */
+ public String getValue() {
+ return value;
+ }
+
+ /**
+ * Appends new data to existing value string.
+ * @param strToAppend String to be appended to existing value string.
+ */
+ public void appendToExistingValue(String strToAppend) {
+ value = value + VALUE_FIELD_SEPARATOR + strToAppend;
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIDetails.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIDetails.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,106 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+import java.util.Iterator;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Stores API details information in the format
+ * that is directly used by UI components.
+ */
+public class APIDetails implements Iterable{
+
+ /**
+ * Stores detail fields.
+ */
+ private Map details;
+
+ /**
+ * Constructor.
+ */
+ public APIDetails(){
+ //Linked hash map preserves the order of the fields
+ //which is needed in this case.
+ details = new LinkedHashMap ();
+ }
+
+ /**
+ * Adds a new field into API details.
+ * @param description Description for the detail.
+ * @param value Value for the detail.
+ */
+ public void addOrUpdateField(String description, String value){
+ APIDetailField oldApiDetail = details.get(description);
+ if(oldApiDetail != null){
+ oldApiDetail.appendToExistingValue(value);
+ }
+ else{
+ details.put(description, new APIDetailField(description, value));
+ }
+ }
+
+ /**
+ * Adds a new field into API details.
+ * @param field to be added.
+ */
+ public void addOrUpdateField(APIDetailField field){
+ APIDetailField oldApiDetail = details.get(field.getDescription());
+ if(oldApiDetail != null){
+ oldApiDetail.appendToExistingValue(field.getValue());
+ }
+ else{
+ details.put(field.getDescription(), field);
+ }
+ }
+
+ /**
+ * Gets the details as an iterator.
+ * @return Iterator containing detail fields.
+ */
+ public Iterator iterator(){
+ return details.values().iterator();
+ }
+
+ /**
+ * Gets the keys. Can be used for getting fields by description this.getDetail(key)
+ * @return Iterator containing detail fields.
+ */
+ public Set getKeys(){
+ return details.keySet();
+ }
+
+ /**
+ * Get value for for the description
+ * @param description
+ * @return API Detail Field or new APIDetailField with given description and empty ("") value if not exist.
+ * @see com.nokia.s60tools.apiquery.shared.util.xml.XMLUtils
+ * public static variables for description keys.
+ */
+ public APIDetailField getDetail(String description){
+ APIDetailField detail = details.get(description);
+ if(detail != null){
+ return detail;
+ }else{
+ return new APIDetailField(description,""); //$NON-NLS-1$
+ }
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIQueryParameters.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIQueryParameters.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,243 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+import java.util.ArrayList;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+
+/**
+ * Used to store parameters for an API query.
+ */
+public class APIQueryParameters {
+
+
+ //
+ // Query types
+ //
+ public static final int QUERY_BY_API_NAME = 1;
+ public static final int QUERY_BY_SUBSYSTEM_NAME = 2;
+ public static final int QUERY_BY_DLL_NAME = 3;
+ public static final int QUERY_BY_LIB_NAME = 4;
+ public static final int QUERY_BY_HEADER_NAME = 5;
+ public static final int QUERY_BY_CRPS_KEY_NAME = 6;
+
+ /**
+ * Search can contain multiple search items that can be
+ * separated with this separator char.
+ */
+ public static final String SEARCH_ITEM_SEPARATOR_CHAR = ";"; //$NON-NLS-1$
+
+ /**
+ * Query type.
+ */
+ private final int queryType;
+
+ /**
+ * Search string used for the query.
+ */
+ private final String searchString;
+
+ /**
+ * Is query from UI thread or not
+ */
+ private boolean isQueryFromUI = true;
+
+ /**
+ * is API Details ment to add to Descriptions when search is done.
+ */
+ private boolean isDetailsMentToAddToDescriptions = false;
+
+ /**
+ * If Exact match shoud be used instead of contains when search results is gathered.
+ */
+ boolean isExactMatchInUse = false;
+
+ /**
+ * Constructor.
+ * @param queryType Query type.
+ * @param searchString Search string used for the query.
+ * @throws java.lang.IllegalArgumentException
+ * @see java.lang.IllegalArgumentException
+ */
+ public APIQueryParameters(int queryType, String searchString){
+ this.queryType = queryType;
+ this.searchString = searchString.trim();
+ validateArguments();
+ }
+
+
+ /**
+ * @return the isQueryFromUI
+ */
+ public boolean isQueryFromUI() {
+ return isQueryFromUI;
+ }
+
+
+ /**
+ * @param isQueryFromUI the isQueryFromUI to set
+ */
+ public void setQueryFromUI(boolean isQueryFromUI) {
+ this.isQueryFromUI = isQueryFromUI;
+ }
+
+
+ /**
+ * Validating the parameter data.
+ * @throws java.lang.IllegalArgumentException
+ * @see java.lang.IllegalArgumentException
+ */
+ private void validateArguments() {
+ if(queryType < 1 || queryType >6){
+ throw new IllegalArgumentException(Messages.getString("APIQueryParameters.UnsupportedQueryType_Msg") + queryType); //$NON-NLS-1$
+ }
+ }
+
+
+ /**
+ * @return the queryType
+ */
+ public int getQueryType() {
+ return queryType;
+ }
+
+
+ /**
+ * @return the searchString
+ */
+ public String getSearchString() {
+ return searchString;
+ }
+
+ /**
+ * Returns currently supported query types.
+ * @return Array of integer constants for the currently
+ * supported query types.
+ */
+ public static Integer[] getQueryTypes(){
+ ArrayList queryTypesArr = new ArrayList();
+ for (int i = QUERY_BY_API_NAME; i <= QUERY_BY_CRPS_KEY_NAME; i++) {
+ queryTypesArr.add(new Integer(i));
+ }
+ return queryTypesArr.toArray(new Integer[0]);
+ }
+
+ /**
+ * Maps query type to description.
+ * @param queryType Query type constant.
+ * @return Description for the given query type.
+ */
+ public static String getDescriptionForQueryType(int queryType){
+
+ String desc = null;
+
+ switch (queryType) {
+
+ case QUERY_BY_API_NAME:
+ desc = Messages.getString("APIQueryParameters.APIName_Msg"); //$NON-NLS-1$
+ break;
+
+ case QUERY_BY_SUBSYSTEM_NAME:
+ desc = Messages.getString("APIQueryParameters.SubsystemName_Msg"); //$NON-NLS-1$
+ break;
+
+ case QUERY_BY_DLL_NAME:
+ desc = Messages.getString("APIQueryParameters.DLLName_Msg"); //$NON-NLS-1$
+ break;
+
+ case QUERY_BY_LIB_NAME:
+ desc = Messages.getString("APIQueryParameters.LIBName_Msg"); //$NON-NLS-1$
+ break;
+
+ case QUERY_BY_HEADER_NAME:
+ desc = Messages.getString("APIQueryParameters.HeaderName_Msg"); //$NON-NLS-1$
+ break;
+
+ case QUERY_BY_CRPS_KEY_NAME:
+ desc = Messages.getString("APIQueryParameters.CR_PS_Name_Msg"); //$NON-NLS-1$
+ break;
+
+ default:
+ throw new IllegalArgumentException(Messages.getString("APIQueryParameters.QueryTypePart1_ErrMsg") //$NON-NLS-1$
+ + queryType
+ + Messages.getString("APIQueryParameters.QueryTypePart2_ErrMsg") //$NON-NLS-1$
+ );
+ }
+
+ return desc;
+ }
+
+
+
+
+ /**
+ * Maps query type to description.
+ * @param queryType Query type constant as Integer object..
+ * @return Description for the given query type.
+ */
+ public static String getDescriptionForQueryType(Integer queryType){
+ return getDescriptionForQueryType(queryType.intValue());
+ }
+
+ /**
+ * Gets default query type.
+ * @return Returns default query type.
+ */
+ public static int getDefaultQueryType(){
+ // NOTE: This query type SHOULD be supported by ALL search methods.
+ return QUERY_BY_API_NAME;
+ }
+
+
+ /**
+ * Check if {@link APIDetails} should be added to {@link APIShortDescription}:s when
+ * query is executed.
+ * @return true if API Details should be added to Descriptions, false otherwise.
+ */
+ public boolean isDetailsMentToAddToDescriptions() {
+ return isDetailsMentToAddToDescriptions ;
+ }
+ /**
+ * Set if {@link APIDetails} should be added to {@link APIShortDescription}:s when
+ * query is executed.
+ * @param true if {@link APIDetails} should be added to {@link APIShortDescription}:s when
+ * query is executed.
+ */
+ public void setDetailsMentToAddToDescriptions(
+ boolean isDetailsMentToAddToDescriptions) {
+ this.isDetailsMentToAddToDescriptions = isDetailsMentToAddToDescriptions;
+ }
+
+ /**
+ * Check if exact match should be used instead of contain when search results are compared
+ * @return the isExactMatchInUse true if exact match should be used, false otherwise.
+ */
+ public boolean isExactMatchInUse() {
+ return isExactMatchInUse;
+ }
+
+
+ /**
+ * Set if exact match should be used instead of contain when search results are compared.
+ * @param isExactMatchInUse true if exact match should be used, false otherwise.
+ */
+ public void setExactMatchInUse(boolean isExactMatchInUse) {
+ this.isExactMatchInUse = isExactMatchInUse;
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIShortDescription.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIShortDescription.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,116 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+import java.util.ArrayList;
+
+/**
+ * Stores information related to a single API Summary
+ * object to be shown in UI.
+ */
+public class APIShortDescription {
+
+ /**
+ * Name of the API in question.
+ */
+ private final String name;
+
+ /**
+ * Source this informatio summary is got from.
+ */
+ private final String source;
+
+ /**
+ * Description for the source shown in the UI.
+ */
+ private final String sourceDescription;
+
+ private ArrayList detailsShortData = null;
+
+
+ private APIDetails apiDetails = null;
+
+ /**
+ * Constructor.
+ * @param name Name of the API.
+ * @param source Source this information summary is got from. Can be used
+ * to find further details.
+ * @param sourceDescription Description for the source shown in the UI.
+ */
+ public APIShortDescription(String name, String source, String sourceDescription){
+ this.name = name;
+ this.source = source;
+ this.sourceDescription = sourceDescription;
+ }
+
+ /**
+ * @return the name
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * @return the source
+ */
+ public String getSource() {
+ return source;
+ }
+
+ /**
+ * @return the sourceDescription
+ */
+ public String getSourceDescription() {
+ return sourceDescription;
+ }
+
+ /**
+ * Set API Details for this Description
+ * @param apiDetails
+ */
+ public void setAPIDetails(APIDetails apiDetails) {
+ this.apiDetails = apiDetails;
+ }
+
+ /**
+ * Get API Details for this Description
+ * @param apiDetails or null if not set.
+ */
+ public APIDetails getAPIDetails() {
+ return apiDetails;
+ }
+
+ /**
+ * Check if this Description has {@link APIDetails} added.
+ * @return true if API Details is added, false otherwise.
+ */
+ public boolean hasAPIDetails(){
+ return apiDetails != null;
+ }
+
+ public void addSerachedData (ArrayList serachedData) {
+
+ this.detailsShortData =serachedData;
+ }
+
+public ArrayList getSearchedData()
+{
+ return detailsShortData;
+}
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIShortDescriptionSearchResults.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/APIShortDescriptionSearchResults.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,114 @@
+/*
+* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Iterator;
+
+import com.nokia.s60tools.apiquery.shared.exceptions.QueryOperationFailedException;
+
+/**
+ * Class for holding search results and search errors.
+ */
+public class APIShortDescriptionSearchResults {
+
+ public APIShortDescriptionSearchResults(){
+ searchResults = new ArrayList();
+ searchErrors = new ArrayList();
+ }
+
+ /**
+ * Search results
+ */
+ private Collection searchResults = null;
+
+ /**
+ * Search errors
+ */
+ private Collection searchErrors = null;
+
+ /**
+ * @return the searchResults
+ */
+ public Collection getSearchResults() {
+ return searchResults;
+ }
+
+ /**
+ * @param searchResults the searchResults to set
+ */
+ public void addSearchResults(Collection searchResults) {
+ //Can't add null to results
+ if(searchResults != null){
+ this.searchResults.addAll(searchResults);
+ }
+ }
+
+ /**
+ * Get errors occurred when queries was executed
+ * @return the searchErrors
+ */
+ public Collection getSearchErrors() {
+ return searchErrors;
+ }
+
+ /**
+ * Add one search error.
+ * @param searchError
+ */
+ public void addSearchError(QueryOperationFailedException searchError) {
+
+ if(searchError != null){
+ this.searchErrors.add(searchError);
+ }
+ }
+
+ /**
+ * Check if there was some errors whit queries.
+ * @return true if there was some errors false otherwise.
+ */
+ public boolean hasErrors(){
+ return !this.searchErrors.isEmpty();
+ }
+
+ /**
+ * Get all error messages. One message takes one line, so if there is many errors there is as many lines of text also.
+ * @return Errors as list or empty string if there was not any.
+ */
+ public String getErrorMessages(){
+ if(!hasErrors()){
+ return new String();
+ }
+ else{
+ StringBuffer errors = new StringBuffer();
+ int count = searchErrors.size();
+ int i = 0;
+ for (Iterator iterator = searchErrors.iterator(); iterator.hasNext();) {
+ QueryOperationFailedException err = (QueryOperationFailedException) iterator.next();
+ errors.append(err.getMessage());
+ if(count > 1 && i < (count - 1)){
+ errors.append("\n");//$NON-NLS-1$
+ }
+ i++;
+ }
+ return errors.toString();
+ }
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/FieldMappingRules.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/FieldMappingRules.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,78 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+
+/**
+ * Stores field mapping rules that can be used to
+ * map API detail field descriptions to XML
+ * and vice versa.
+ */
+public class FieldMappingRules {
+
+ /**
+ * Storage for the mapping rules.
+ */
+ Map ruleMap;
+
+ /**
+ * Constructor
+ */
+ public FieldMappingRules(){
+ ruleMap = new HashMap();
+ }
+
+ /**
+ * Adds a new rule to the mapping rules.
+ * @param mapFromStr String to map from.
+ * @param mapToStr String to map into.
+ */
+ public void addRule(String mapFromStr, String mapToStr){
+ ruleMap.put(mapFromStr, mapToStr);
+ }
+
+ /**
+ * Gets the string that was mapped into the given parameter string.
+ * @param keyStr Key string to ask mapped result for.
+ * @return Returns result string or throws IllegalArgumentException
+ * if no .
+ * @throws java.lang.IllegalArgumentException
+ * @see java.lang.IllegalArgumentException
+ */
+ public String mapFrom(String keyStr){
+ String resultStr = ruleMap.get(keyStr);
+ if(resultStr == null){
+ throw new IllegalArgumentException(Messages.getString("FieldMappingRules.NoMappingRule_ErrMsg") + keyStr); //$NON-NLS-1$
+ }
+ return resultStr;
+ }
+
+ /**
+ * Returns key set that this field mapping rule instance
+ * has mapping rules for.
+ * @return Set of String key values.
+ */
+ public Set getMapFromKeySet(){
+ return ruleMap.keySet();
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/QueryErrorInfo.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/QueryErrorInfo.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,48 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+/**
+ * Simple class for storing error information returned query operations.
+ * This is needed because queries are runned inside a runnable and
+ * error info is got via try/catch, and the error information usage
+ * related needs to be done outside runnable where catch is made.
+ * This class should stay with package private visibility.
+ */
+public class QueryErrorInfo{
+ /**
+ * Error description is set on failure.
+ */
+ private String errorDescription = new String();
+
+ /**
+ * Gets error description.
+ * @return the errorDescription
+ */
+ public String getErrorDescription() {
+ return errorDescription;
+ }
+
+ /**
+ * Sets error description.
+ * @param errorDescription the errorDescription to set
+ */
+ public void setErrorDescription(String errorDescription) {
+ this.errorDescription = errorDescription;
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/XMLToUIMappingRules.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/XMLToUIMappingRules.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,132 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Extends field mapping rules class by
+ * including definitions for attributes.
+ */
+public class XMLToUIMappingRules extends FieldMappingRules {
+
+ /**
+ * Storage for attributes that are examined for a certain
+ * element.
+ */
+ private Map > attributeMap;
+
+ /**
+ * Storing rules that enforces that rule does not match
+ * unless the parent element also matches.
+ * It is optional to set this restriction for a rule.
+ */
+ private Map parentElementRestrictionMap = null;
+
+
+ /**
+ * Constructor.
+ */
+ public XMLToUIMappingRules(){
+ super();
+ attributeMap = new HashMap>();
+ parentElementRestrictionMap = new HashMap();
+ }
+
+ /**
+ * Adds a new rule to the mapping rules including
+ * a set of attribute names to be stored.
+ * @param elementNameStr Element name string to map from.
+ * @param mapToStr String to map into.
+ * @param attributes Set of attribute names to be converted.
+ */
+ public void addRule(String elementNameStr, String mapToStr, Map attributes){
+ super.addRule(elementNameStr, mapToStr);
+ attributeMap.put(elementNameStr, attributes);
+ }
+
+
+ /**
+ * @return the attributeMap
+ */
+ public Map> getAttributeMap() {
+ return attributeMap;
+ }
+
+ /**
+ * Adds a new rule to the mapping rules.
+ * @param mapFromStr String to map from.
+ * @param mapToStr String to map into.
+ * @param parentElementRestriction Rule matches only if the parent name matches.
+ */
+ public void addRule(String mapFromStr, String mapToStr, String parentElementRestriction){
+ this.parentElementRestrictionMap.put(mapFromStr, parentElementRestriction);
+ ruleMap.put(mapFromStr, mapToStr);
+ }
+
+ /**
+ * Adds a new rule to the mapping rules including
+ * a set of attribute names to be stored.
+ * @param elementNameStr Element name string to map from.
+ * @param mapToStr String to map into.
+ * @param parentElementRestriction Rule matches only if the parent name matches.
+ * @param attributes Set of attribute names to be converted.
+ */
+ public void addRule(String elementNameStr, String mapToStr,
+ String parentElementRestriction, Map attributes){
+ super.addRule(elementNameStr, mapToStr);
+ this.parentElementRestrictionMap.put(elementNameStr, parentElementRestriction);
+ attributeMap.put(elementNameStr, attributes);
+ }
+
+
+ /**
+ * Gets parent element restriction for an element.
+ * @param elementNameStr Element name.
+ * @return parent element restriction or null if does not exist.
+ */
+ public String getParentElementRestriction(String elementNameStr) {
+ return parentElementRestrictionMap.get(elementNameStr);
+ }
+
+ /**
+ * Check existence of parent element restriction for an element.
+ * @param elementNameStr Element name.
+ * @return true if has restriction, otherwise false.
+ */
+ public boolean hasParentElementRestriction(String elementNameStr) {
+ return parentElementRestrictionMap.containsKey(elementNameStr);
+ }
+
+ /**
+ * Return parent restrictions for conversion rules.
+ * @return Parent restrictions for conversion rules.
+ */
+ public Map getParentElementRestrictionMap() {
+ return parentElementRestrictionMap;
+ }
+
+ /**
+ * Get map for attribute header names
+ * @return attribute headers or null if not set
+ */
+ public Map getAttributeNamesMap(String elementNameStr) {
+ return getAttributeMap().get(elementNameStr);
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/AbstractEntry.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/AbstractEntry.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,129 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes.config;
+
+import com.nokia.s60tools.apiquery.settings.UserSettings;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtensionInfo;
+import com.nokia.s60tools.apiquery.shared.searchmethodregistry.SearchMethodExtensionRegistry;
+
+
+/**
+ * Abstract entry base class that contains only id for the
+ * entry and method that are common for all entry types.
+ *
+ * To be subclassed in order to create concrete entry types.
+ */
+public abstract class AbstractEntry {
+
+ /**
+ * User configurable id for the entry. The entries
+ * are identified by there unique id per search method
+ * configuration storage.
+ */
+ protected final String id;
+ /**
+ * Set to true if user has selected this entry to
+ * be part of the search, otherwise false,
+ */
+ protected boolean isSelected;
+
+ /**
+ * Constructor
+ * @param id Entry id.that is unique per search method.
+ * @param isSelected Is the entry used for queries by default.
+ */
+ protected AbstractEntry(String id, boolean isSelected){
+ this.id = id;
+ this.isSelected = isSelected;
+ }
+
+ /**
+ * @return the id for the entry.
+ */
+ public String getId() {
+ return id;
+ }
+
+ /**
+ * @return the isSelected
+ */
+ public boolean isSelected() {
+ return isSelected;
+ }
+
+ /**
+ * Sets selection status for the entry
+ * and notifies storage about the modification.
+ * @param isSelected the isSelected to set
+ */
+ public void setSelected(boolean isSelected) {
+ this.isSelected = isSelected;
+ if(isSelected){
+ notifyModification(IConfigurationChangedListener.ENTRY_CHECKED);
+ }
+ else{
+ notifyModification(IConfigurationChangedListener.ENTRY_UNCHECKED);
+ }
+ }
+
+ /**
+ * Sets selection status for the entry
+ * and notifies storage about the modification.
+ * @param isSelected the isSelected to set
+ * @param dontNotifyListeners if true listeners will not be notified.
+ */
+ public void setSelected(boolean isSelected, boolean dontNotifyListeners) {
+ if(dontNotifyListeners){
+ this.isSelected = isSelected;
+ }
+ else {
+ setSelected(isSelected);
+ }
+ }
+
+ /**
+ * Notifies storage object that this entry has been modified.
+ * @param eventType Event type of the modification.
+ */
+ protected void notifyModification(int eventType){
+ ISearchMethodExtensionInfo currSelExtInfo = UserSettings.getInstance().getCurrentlySelectedSearchMethodInfo();
+ String id = currSelExtInfo.getId();
+ ISearchMethodExtension currSelExt = SearchMethodExtensionRegistry.getInstance().getById(id);
+ AbstractEntryStorage storage = currSelExt.getEntryStorageInstance();
+ storage.entryModified(this, eventType);
+ }
+
+ /**
+ * Calls template method to updates concrete type entry-specific data fields
+ * and notifies listeners about the modification.
+ * @param entryWithUpdatedData Entry with new data.
+ */
+ public void updateDataFields(AbstractEntry entryWithUpdatedData){
+ updateEntryTypeSpecificDataFields(entryWithUpdatedData);
+ notifyModification(IConfigurationChangedListener.ENTRY_MODIFIED);
+ }
+
+ /**
+ * The following template method updates concrete type entry-specific data fields.
+ * @param entryWithUpdatedData Entry with new data.
+ */
+ public abstract void updateEntryTypeSpecificDataFields(AbstractEntry entryWithUpdatedData);
+
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/AbstractEntryStorage.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/AbstractEntryStorage.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,261 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes.config;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Iterator;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+
+/**
+ * Abstract entry storage base class that contains only
+ * the methods that are common for all entry types.
+ *
+ * To be subclassed in order to create concrete entry storage.
+ */
+public abstract class AbstractEntryStorage {
+
+ /**
+ * Entry storage Map.
+ */
+ protected Map entriesMap = new LinkedHashMap();
+ /**
+ * Configuration change listener list.
+ */
+ protected ArrayList configChangeListeners = new ArrayList();
+
+ /**
+ * Constructor
+ */
+ protected AbstractEntryStorage(){
+ }
+
+ /**
+ * Adds configuration change listener.
+ * @param listener Configuration change listener.
+ */
+ public void addConfigurationChangeListener(IConfigurationChangedListener listener) {
+ configChangeListeners.add(listener);
+ }
+
+ /**
+ * Removes configuration change listener.
+ * @param listener Configuration change listener.
+ */
+ public void removeConfigurationChangeListener(IConfigurationChangedListener listener) {
+ configChangeListeners.remove(listener);
+ }
+
+ /**
+ * Notifies listeners about the configuration change.
+ * @param eventType Event type .
+ */
+ public void notifyConfigurationChangeListeners(int eventType) {
+ for (IConfigurationChangedListener listener : configChangeListeners) {
+ listener.configurationChanged(eventType);
+ }
+ }
+
+ /**
+ * Adds an entry to the storage.
+ * @param entry Entry to be added.
+ * @throws DuplicateEntryException
+ */
+ public void addEntry(AbstractEntry entry) throws DuplicateEntryException {
+ if(entriesMap.get(entry.getId()) != null){
+ String duplicateEntriesErrMsg = Messages.getString("AbstractEntryStorage.Duplicate_ErrMsg"); //$NON-NLS-1$
+ throw new DuplicateEntryException(duplicateEntriesErrMsg);
+ }
+ entriesMap.put(entry.getId(), entry);
+ notifyConfigurationChangeListeners(IConfigurationChangedListener.ENTRY_ADDED);
+ }
+
+ /**
+ * Updates an entry to the storage.
+ * @param entryWithNewData Entry object containing new data.
+ * @throws EntryNotFoundException
+ */
+ public void updateEntry(AbstractEntry entryWithNewData) throws EntryNotFoundException {
+ AbstractEntry entryWithOldData = (AbstractEntry) entriesMap.get(entryWithNewData.getId());
+ if(entryWithOldData == null){
+ String nonExistingEntryMsg = Messages.getString("AbstractEntryStorage.NonExistingEntry_ErrMsg") + entryWithNewData.getId(); //$NON-NLS-1$
+ throw new EntryNotFoundException(nonExistingEntryMsg);
+ }
+ // Updating data fields (which triggers notification to configuration change listeners)
+ entryWithOldData.updateDataFields(entryWithNewData);
+ }
+
+ /**
+ * Removes the given entry from the storage.
+ * @param entry Entry.
+ */
+ public void removeEntry(AbstractEntry entry) {
+ entriesMap.remove(entry.getId());
+ notifyConfigurationChangeListeners(IConfigurationChangedListener.ENTRY_REMOVED);
+ }
+
+ /**
+ * Remove all entrys.
+ */
+ public void removeAllEntrys() {
+ entriesMap.clear();
+ notifyConfigurationChangeListeners(IConfigurationChangedListener.ALL_ENTRYS_REMOVED);
+ }
+
+
+ /**
+ * Returns the iterator for the currently registered entries.
+ * @return Returns the currently registered entries.
+ */
+ public Collection getEntries() {
+ return entriesMap.values();
+ }
+
+ /**
+ * Gets the amount of currently registered entries.
+ * @return Returns the amount of currently registered entries.
+ */
+ public int getEntryCount() {
+ return getEntries().size();
+ }
+
+ /**
+ * Gets the entry that matches with the given id.
+ * @param entryId Id for the entry.
+ * @return The entry matching the id or null if not found.
+ */
+ public AbstractEntry getByEntryId(String entryId) {
+ for (AbstractEntry entry : getEntries()) {
+ if(entry.getId().equals(entryId)){
+ return entry;
+ }
+ }
+ return null;
+ }
+
+
+ /**
+ * Returns those entries that are selected by used from entry storage.
+ * @return Colletion of selected entries.
+ */
+ public Collection getSelectedEntriesCollection() {
+ ArrayList selectedList = new ArrayList();
+ for (Iterator iter = getEntries().iterator(); iter.hasNext();) {
+ AbstractEntry entry = (AbstractEntry) iter.next();
+ if(entry.isSelected()){
+ selectedList.add(entry);
+ }
+ }
+ return selectedList;
+ }
+
+ /**
+ * Returns those entries that are selected by used from entry storage.
+ * @return Array of selected entries.
+ */
+ public AbstractEntry[] getSelectedEntries() {
+ ArrayList selectedList = new ArrayList();
+ for (Iterator iter = getEntries().iterator(); iter.hasNext();) {
+ AbstractEntry entry = (AbstractEntry) iter.next();
+ if(entry.isSelected()){
+ selectedList.add(entry);
+ }
+ }
+ return selectedList.toArray(new AbstractEntry[0]);
+ }
+
+ /**
+ * Checks if the given entry is part of the storage.
+ * @param entry Entry object.
+ * @return true if part of the storage, otherwise false.
+ */
+ public boolean contains(AbstractEntry entry) {
+ return entriesMap.containsKey(entry.getId());
+ }
+
+ /**
+ * Informs storage that an entry has been modified. Storage
+ * informs further the configuration listeners, if this
+ * entry was part active configuration.
+ * @param entry Entry object.
+ * @param eventType Event type for modification.
+ */
+ public void entryModified(AbstractEntry entry, int eventType) {
+ if(contains(entry)){
+ // Active configuration has been changed.
+ notifyConfigurationChangeListeners(eventType);
+ }
+ }
+
+ /**
+ * Selects all stored entries and notifies listeners.
+ */
+ public void selectAll() {
+ for (AbstractEntry entry : getEntries()) {
+ ((AbstractEntry)entry).setSelected(true);
+ }
+ notifyConfigurationChangeListeners(IConfigurationChangedListener.ALL_ENTRIES_CHECKED);
+ }
+
+ /**
+ * Selects all stored entries and notifies listeners.
+ */
+ public void deselectAll() {
+ for (AbstractEntry entry : getEntries()) {
+ ((AbstractEntry)entry).setSelected(false);
+ }
+ notifyConfigurationChangeListeners(IConfigurationChangedListener.ALL_ENTRIES_UNCHECKED);
+ }
+
+ /**
+ * Selects all stored entries and notifies listeners.
+ * @param notifyListenersOnlyWhenAllDeselected if true listeners will be
+ * notified only when all entrys is deselected, not one by one when deselecting entrys.
+ */
+ public void deselectAll(boolean notifyListenersOnlyWhenAllDeselected) {
+
+ if(notifyListenersOnlyWhenAllDeselected){
+ for (AbstractEntry entry : getEntries()) {
+ ((AbstractEntry)entry).setSelected(false, true);
+ }
+ notifyConfigurationChangeListeners(IConfigurationChangedListener.ALL_ENTRIES_UNCHECKED);
+ }else{
+ deselectAll();
+ }
+
+ }
+
+ /**
+ * Saves the configuration into an external configuration file.
+ * Note: Overwrites the contents of the external file.
+ * @param destinationFileAbsolutePathName Absolute pathname for the external configuration file to be used.
+ * @throws IOException
+ */
+ public abstract void save(String destinationFileAbsolutePathName) throws IOException;
+
+ /**
+ * Loads the configuration into an external configuration file.
+ * @param storageFilePathName Absolute path name for the configuration file.
+ * @throws IOException
+ */
+ public abstract void load(String storageFilePathName) throws IOException;
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/DuplicateEntryException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/DuplicateEntryException.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,53 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes.config;
+
+/**
+ * This exception might be raised by the search methods
+ * when query operation fails due to some reason.
+ *
+ * There might be several reasons for the failure such as:
+ *
+ * - Missing or invalid configuration information to run
+ * the query operation.
+ * - Required data is not availabe (due to network restrictions, cached data
+ * is missing from the local disk etc.)
+ */
+public class DuplicateEntryException extends Exception {
+
+ /**
+ * Serial versio UID.
+ */
+ private static final long serialVersionUID = -4168668065952326532L;
+
+ /**
+ * Default constructor is hidden from the user.
+ */
+ @SuppressWarnings("unused")
+ private DuplicateEntryException(){
+ super();
+ }
+
+ /**
+ * Only publicly available constructor is one with detailed error information.
+ * @param errorMessage Detailed information about the error that caused the exception.
+ */
+ public DuplicateEntryException(String errorMessage){
+ super(errorMessage);
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/EntryNotFoundException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/EntryNotFoundException.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,53 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.datatypes.config;
+
+/**
+ * This exception might be raised by the search methods
+ * when query operation fails due to some reason.
+ *
+ * There might be several reasons for the failure such as:
+ *
+ * - Missing or invalid configuration information to run
+ * the query operation.
+ * - Required data is not availabe (due to network restrictions, cached data
+ * is missing from the local disk etc.)
+ */
+public class EntryNotFoundException extends Exception {
+
+ /**
+ * Serial versio UID.
+ */
+ private static final long serialVersionUID = 803831180171819626L;
+
+ /**
+ * Default constructor is hidden from the user.
+ */
+ @SuppressWarnings("unused")
+ private EntryNotFoundException(){
+ super();
+ }
+
+ /**
+ * Only publicly available constructor is one with detailed error information.
+ * @param errorMessage Detailed information about the error that caused the exception.
+ */
+ public EntryNotFoundException(String errorMessage){
+ super(errorMessage);
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/IConfigurationChangedListener.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/datatypes/config/IConfigurationChangedListener.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,82 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.datatypes.config;
+
+/**
+ * Interface for the services that needs to know if
+ * configuration has been changed.
+ */
+public interface IConfigurationChangedListener {
+
+ /**
+ * Entry added event type.
+ */
+ public static final int ENTRY_ADDED = 0;
+
+ /**
+ * Entry modified event type.
+ */
+ public static final int ENTRY_MODIFIED = 1;
+
+ /**
+ * Entry removed event type.
+ */
+ public static final int ENTRY_REMOVED = 2;
+
+ /**
+ * Entry selected event type.
+ */
+ public static final int ENTRY_CHECKED = 3;
+
+ /**
+ * Entry deselected event type.
+ */
+ public static final int ENTRY_UNCHECKED = 4;
+
+ /**
+ * All entries selected event type.
+ */
+ public static final int ALL_ENTRIES_CHECKED = 5;
+
+ /**
+ * All entries deselected event type.
+ */
+ public static final int ALL_ENTRIES_UNCHECKED = 6;
+
+ /**
+ * All Entrys removed event type.
+ */
+ public static final int ALL_ENTRYS_REMOVED = 7;
+
+ /**
+ * All Entrys updated event type.
+ */
+ public static final int ALL_ENTRYS_UPDATED = 8;
+
+ /**
+ * All selected Entrys removed event type.
+ */
+ public static final int ALL_SELECTED_ENTRYS_REMOVED = 9;
+
+ /**
+ * Configuration change notification method.
+ * @param eventType One of the event types define in this interface.
+ */
+ public void configurationChanged(int eventType);
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/exceptions/QueryOperationFailedException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/exceptions/QueryOperationFailedException.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,76 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.exceptions;
+
+import java.util.Collection;
+
+import com.nokia.s60tools.apiquery.shared.datatypes.APIShortDescription;
+
+/**
+ * This exception might be raised by the search methods
+ * when query operation fails due to some reason.
+ *
+ * There might be several reasons for the failure such as:
+ *
+ * - Missing or invalid configuration information to run
+ * the query operation.
+ * - Required data is not availabe (due to network restrictions, cached data
+ * is missing from the local disk etc.)
+ */
+public class QueryOperationFailedException extends Exception {
+
+ /**
+ * Serial versio UID.
+ */
+ private static final long serialVersionUID = -8124615355279044581L;
+
+ /**
+ * API Query summarys for search if those was gathered before error occurred
+ */
+ private Collection summary = null;
+
+ /**
+ * Default constructor is hidden from the user.
+ */
+ @SuppressWarnings("unused")
+ private QueryOperationFailedException(){
+ super();
+ }
+
+ /**
+ * Only publicly available constructor is one with detailed error information.
+ * @param errorMessage Detailed information about the error that caused the exception.
+ */
+ public QueryOperationFailedException(String errorMessage){
+ super(errorMessage);
+ }
+
+ /**
+ * Set summarys for this exeption
+ * @param summary
+ */
+ public void setSummarys(Collection summary) {
+ this.summary = summary;
+ }
+ /**
+ * @return the summarys or null if not set
+ */
+ public Collection getSummarys() {
+ return summary;
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/exceptions/XMLNotValidException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/exceptions/XMLNotValidException.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,58 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.exceptions;
+
+/**
+ * Thrown when invalid XML data is encountered.
+ */
+public class XMLNotValidException extends Exception {
+
+ private static final long serialVersionUID = -3037053770134709611L;
+ private String fileName = null;
+
+ /**
+ * Private hidden constructor.
+ */
+ @SuppressWarnings("unused")
+ private XMLNotValidException(){
+ super();
+ }
+ /**
+ * Public constructor coming always with descriptive message.
+ */
+ public XMLNotValidException(String message){
+ super(message);
+ }
+
+ /**
+ * Public constructor coming always with descriptive message.
+ */
+ public XMLNotValidException(String message, String fileName){
+ super(message);
+ this.fileName = fileName;
+ }
+
+ /**
+ * Get file name
+ * @return file name or null if not set.
+ */
+ public String getFileName() {
+ return fileName;
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/AbstractJob.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/AbstractJob.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,159 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.job;
+
+import java.util.Date;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.jobs.Job;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+/**
+ * Abstract implementation of {@link Job}. Implements few functionalities so sub classes
+ * can be written with less code.
+ */
+public abstract class AbstractJob extends Job implements IJobProgressStatus, IManageableJob{
+
+ protected static final int PROGRESS_COMPLETED_PERCENTAGE = 100;
+ protected int previousPercentage = 0;
+ private IProgressMonitor monitor = null;
+ private Process process = null;
+ private long runMethodStartTime;
+
+ protected int steps = 100; // percentage figure
+
+ /**
+ * Use only this constructor
+ *
+ * @param name Job name (root component name)
+ */
+ public AbstractJob(String name) {
+ super(name);
+ }
+
+ /**
+ * Get start time and print it
+ * @return start time in ms (System.currentTimeMillis())
+ */
+ public long reportStartTime(){
+ this.runMethodStartTime = System.currentTimeMillis();
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION,
+ "Job: '" +super.getName() + "' start time: " //$NON-NLS-1$ //$NON-NLS-2$
+ + new Date(runMethodStartTime).toString());
+ return runMethodStartTime;
+ }
+
+ /**
+ * count time taken since startTime, printing it
+ * @param runMethodStartTime
+ */
+ public void reportEndTime(){
+ long endTime = System.currentTimeMillis();
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION,
+ "Job " +super.getName() + " ended: " + new Date(endTime).toString()); //$NON-NLS-1$ //$NON-NLS-2$
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION,
+ "TOTAL: " //$NON-NLS-1$
+ + (endTime-runMethodStartTime)/1000.0 + " seconds!"); //$NON-NLS-1$
+ }
+
+
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.job.IJobProgressStatus#progress(int, java.lang.String)
+ */
+ public void progress(int percentage, String prosessing)
+ throws JobCancelledByUserException {
+
+ if (isCanceled()){
+ String msg = Messages.getString("AbstractJob.JobCancelled_Part1_ErrMsg") +super.getName() + Messages.getString("AbstractJob.JobCancelled_Part2_ErrMsg"); //$NON-NLS-1$ //$NON-NLS-2$
+ throw new JobCancelledByUserException(msg);
+ }
+ //Making sure that there is no percentages higher than 100
+ if(percentage > PROGRESS_COMPLETED_PERCENTAGE){
+ percentage = PROGRESS_COMPLETED_PERCENTAGE;
+ }
+
+ monitor.subTask(percentage + Messages.getString("AbstractJob.Percentage_Complete_Msg") //$NON-NLS-1$
+ + Messages.getString("AbstractJob.Prosessing_Msg") //$NON-NLS-1$
+ + prosessing);
+ monitor.worked(percentage - previousPercentage);
+ previousPercentage = percentage;
+
+ }
+
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.job.IJobProgressStatus#isCanceled()
+ */
+ public boolean isCanceled() {
+ return monitor.isCanceled();
+ }
+
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.job.IManageableJob#forcedShutdown()
+ */
+ public void forcedShutdown() {
+ if(process != null){
+ process.destroy();
+ try {
+ process.waitFor();
+ } catch (InterruptedException e) {
+ e.printStackTrace();
+ }
+ }
+ }
+
+
+ /**
+ * Get Process
+ * @return Process
+ */
+ protected Process getProcess() {
+ return process;
+ }
+
+
+ /**
+ * Set process
+ * @param process
+ */
+ protected void setProcess(Process process) {
+ this.process = process;
+ }
+
+ /**
+ * Get progress monitor
+ * @return
+ */
+ protected IProgressMonitor getMonitor() {
+ return monitor;
+ }
+
+ /**
+ * Set progress monitor to this Job
+ * @param monitor
+ */
+ protected void setMonitor(IProgressMonitor monitor) {
+ this.monitor = monitor;
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/FindFileFromFoldersJob.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/FindFileFromFoldersJob.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,235 @@
+/*
+* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.job;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.util.Collection;
+import java.util.Iterator;
+import java.util.List;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.jobs.Job;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.util.resource.FileFinder;
+import com.nokia.s60tools.util.resource.IFileFinderObserver;
+
+/**
+ * Job for seeking header file from under SDK:s include paths given given.
+ */
+public class FindFileFromFoldersJob extends AbstractJob implements IFileFinderObserver {
+
+
+
+ /**
+ * Total steps as double, to be able to count percentages.
+ */
+ double stepsAsDouble = 1;
+
+ /**
+ * Name of the file to be seeked
+ */
+ private final String fileName;
+
+ /**
+ * Paths where to seek the file
+ */
+ private final List paths;
+
+ /**
+ * Unique ID of SDK where file is seeked.
+ */
+ private final String sdkId;
+
+ /**
+ * Collection holds files found to be returned for client.
+ */
+ private Collection foundFiles = null;
+
+
+ /**
+ * Create a Job to seek .metaxml files under selected SDK.
+ * @param name
+ * @param sdkInformation
+ */
+ public FindFileFromFoldersJob(String name, List paths, String fileName, String sdkId) {
+ super(name);
+ this.paths = paths;
+ this.fileName = fileName;
+ this.sdkId = sdkId;
+ setUser(true);
+ }
+
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime.IProgressMonitor)
+ */
+ protected IStatus run(IProgressMonitor monitor) {
+ setMonitor(monitor);
+ try {
+ reportStartTime();
+ FileFinder finder = new FileFinder(APIQueryConsole.getInstance());
+
+ String fileNames [] = new String[1];
+ fileNames[0] = fileName;
+ String [] folders = new String[paths.size()];
+ int i = 0;
+ for (Iterator iterator = paths.iterator(); iterator.hasNext();) {
+ File file = (File) iterator.next();
+ folders[i] = file.getAbsolutePath();
+ i++;
+ }
+ finder.seekFilesFromFolders(this, fileNames, folders);
+ return Job.ASYNC_FINISH;
+ } catch (Exception e) {
+ IStatus status = new Status(
+ Status.ERROR,Platform.PI_RUNTIME,
+ Status.ERROR,Messages.getString("FindFileFromFoldersJob.ErrorOnSeekin_StatusMsg_Part1") +fileName +Messages.getString("FindFileFromFoldersJob.ErrorOnSeekin_StatusMsg_Part2") +sdkId, e); //$NON-NLS-1$ //$NON-NLS-2$
+ return status;
+ }
+
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.util.resource.IFileFinderObserver#completed(int, java.util.Collection)
+ */
+ public void completed(int exitValue, Collection files) {
+
+ try {
+ if(isCanceled() || exitValue == IStatus.CANCEL){
+ interrupted(Messages.getString("FindFileFromFoldersJob.CancelledByUser_Msg")); //$NON-NLS-1$
+ }
+ else if(exitValue == IStatus.OK){
+ handleSeekCompleatedOK(files);
+ }
+ else{
+ handleSeekCompleatedError(exitValue);
+ }
+ reportEndTime();
+ } catch (Exception e) {
+ //Handle file not found e.g. errors.
+ e.printStackTrace();
+ handleSeekCompleatedError(e);
+ }
+ }
+
+ /**
+ * Handle Error situations after getting data
+ * @param e
+ */
+ private void handleSeekCompleatedError(Exception e) {
+ String message = Messages.getString("FindFileFromFoldersJob.ErrorSeekingFile_ErrMsg_Part1") +fileName +Messages.getString("FindFileFromFoldersJob.ErrorSeekingFile_ErrMsg_Part2") +sdkId; //$NON-NLS-1$ //$NON-NLS-2$
+ APIQueryConsole.getInstance().println(message, APIQueryConsole.MSG_ERROR);
+ IStatus status = new Status(
+ Status.ERROR,Platform.PI_RUNTIME,
+ Status.ERROR,message, e);
+
+ done(status);
+ }
+
+ /**
+ * Handle error return values
+ * @param exitValue
+ */
+ private void handleSeekCompleatedError(int exitValue) {
+ String message = Messages.getString("FindFileFromFoldersJob.ErrorSeekingFileWithValue_ErrMsg_Part1") +fileName +Messages.getString("FindFileFromFoldersJob.ErrorSeekingFileWithValue_ErrMsg_Part2") +sdkId + Messages.getString("FindFileFromFoldersJob.ErrorSeekingFileWithValue_ErrMsg_Part3") +exitValue; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ APIQueryConsole.getInstance().println(message, APIQueryConsole.MSG_ERROR);
+ IStatus status = new Status(
+ Status.ERROR,Platform.PI_RUNTIME,
+ Status.ERROR,message, null);
+
+ done(status);
+ }
+
+ /**
+ * If status was OK, handling completed situation
+ * @param files
+ * @throws FileNotFoundException
+ * @throws IOException
+ */
+ private void handleSeekCompleatedOK(Collection files) throws FileNotFoundException, IOException {
+
+ //We are pretty much done, so marking that we are in 100% of progress, opening file found won't happen in this job anyway
+ progress(steps, Messages.getString("FindFileFromFoldersJob.FileFound_Progress_Msg_Part1") +fileName +Messages.getString("FindFileFromFoldersJob.FileFound_Progress_Msg_Part2")); //$NON-NLS-1$ //$NON-NLS-2$
+ foundFiles = files;
+ reportEndTime();
+ done(Status.OK_STATUS);
+ }
+
+
+ /**
+ * Get file found in job
+ * @return files found
+ */
+ public Collection getFoundSourceFiles(){
+ return foundFiles;
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.util.resource.IFileFinderObserver#interrupted(java.lang.String)
+ */
+ public void interrupted(String reasonMsg) {
+ done(Status.CANCEL_STATUS);
+ super.cancel();
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.util.resource.IFileFinderObserver#isCancelled()
+ */
+ public boolean isCanceled(){
+ return getMonitor().isCanceled();
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.util.resource.IFileFinderObserver#beginTask(java.lang.String, int)
+ */
+ public void beginTask(String name, int steps) {
+
+ //Its not allowed to dived with "0"
+ if(steps < 1){
+ steps = 1;
+ }
+ this.steps = steps;
+ stepsAsDouble = new Double(steps).doubleValue();
+
+ getMonitor().beginTask(name, PROGRESS_COMPLETED_PERCENTAGE);
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.job.AbstractJob#progress(int, java.lang.String)
+ */
+ public void progress(int stepsCompleated, String prosessing) {
+
+ try {
+ int persentage = (new Double( stepsCompleated / stepsAsDouble * 100)).intValue();
+
+ super.progress(persentage, prosessing);
+ } catch (JobCancelledByUserException e) {
+ e.printStackTrace();
+ done(Status.CANCEL_STATUS);
+ }
+ }
+
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/IJobCompletionListener.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/IJobCompletionListener.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,37 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.job;
+
+import com.nokia.s60tools.apiquery.shared.job.IManageableJob;;
+
+
+
+/**
+ * Listener interface for object requiring information
+ * about successfull cache creation.
+ */
+public interface IJobCompletionListener {
+
+ /**
+ * Informs the listener about successful cache index creation.
+ * @param cacheIndexObj Cache index that was just created.
+ */
+ public void backgroundJobCompleted(IManageableJob jobObject);
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/IJobProgressStatus.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/IJobProgressStatus.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,38 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.job;
+
+
+public interface IJobProgressStatus {
+ /**
+ * Reports progress of a batch process like
+ * execution. It depends on the invoked command
+ * if any progress information can be gained.
+ * @param percentage Progress percentage.
+ * @param processedItem Item that is currently under processing.
+ * @throws JobCancelledByUserException
+ */
+ public void progress(int percentage, String processedItem) throws JobCancelledByUserException;
+
+ /**
+ * Checks if job has been cancelld by the user.
+ * @return Returns true if jobs has been cancelled by user,
+ * otherwise false.
+ */
+ public boolean isCanceled();
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/IManageableJob.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/IManageableJob.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,30 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.job;
+
+/**
+ * Jobs that implement this interface can be asked to
+ * shutdown themselves during their execution. For example,
+ * when a plugin is disposed it is a good idea to request
+ * for all the managed jobs to also interrupt their
+ * execution.
+ */
+public interface IManageableJob {
+ public void forcedShutdown();
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/JobCancelledByUserException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/job/JobCancelledByUserException.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,32 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.job;
+
+/**
+ * {@link Exception} class for Job cancelled by User.
+ */
+public class JobCancelledByUserException extends Exception {
+
+ public JobCancelledByUserException(String msg) {
+ super(msg);
+ }
+
+
+ private static final long serialVersionUID = -235428303120175424L;
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/plugin/APIQueryPlugin.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/plugin/APIQueryPlugin.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,532 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.plugin;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.net.URL;
+import java.util.Collection;
+import java.util.Properties;
+
+import org.eclipse.core.runtime.FileLocator;
+import org.eclipse.core.runtime.IConfigurationElement;
+import org.eclipse.core.runtime.IExtension;
+import org.eclipse.core.runtime.IExtensionPoint;
+import org.eclipse.core.runtime.IExtensionRegistry;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.jface.resource.ImageDescriptor;
+import org.eclipse.jface.resource.ImageRegistry;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.graphics.Image;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.swt.widgets.Shell;
+import org.eclipse.ui.IWorkbenchPage;
+import org.eclipse.ui.plugin.AbstractUIPlugin;
+import org.osgi.framework.BundleContext;
+
+import com.nokia.s60tools.apiquery.settings.IUserSettingsListener;
+import com.nokia.s60tools.apiquery.settings.UserSettings;
+import com.nokia.s60tools.apiquery.shared.common.ProductInfoRegistry;
+import com.nokia.s60tools.apiquery.shared.resources.ImageKeys;
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtensionInfo;
+import com.nokia.s60tools.apiquery.shared.searchmethodregistry.SearchMethodExtensionRegistry;
+import com.nokia.s60tools.apiquery.shared.ui.dialogs.APIQueryMessageBox;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.apiquery.ui.dialogs.FirstTimePopUpDialog;
+import com.nokia.s60tools.util.console.IConsolePrintUtility;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+/**
+ * The main plugin class to be used in the desktop.
+ */
+public class APIQueryPlugin extends AbstractUIPlugin implements IUserSettingsListener {
+
+
+ /**
+ * API Query plugin ID
+ */
+ public static final String PLUGIN_ID ="com.nokia.s60tools.apiquery";//$NON-NLS-1$
+
+ /**
+ * Extension point declared by this plugin the extender
+ * plugins can use for adding new search methods.
+ */
+ private static final String SEARCH_METHOD_EXTENSION_POINT_ID = "com.nokia.s60tools.apiquery.searchMethods"; //$NON-NLS-1$
+
+ /**
+ * Attribute for the extension point that store the name of the class
+ * that implements a search method extension.
+ */
+ private static final String CLASS_ATTRIBUTE = "class"; //$NON-NLS-1$
+
+ /**
+ * Default name for file to store user-configured server entries.
+ */
+ private static final String DATA_SOURCES_PROPERTIES_FILE_NAME = "datasources.properties"; //$NON-NLS-1$
+
+ /**
+ * Property name for getting selected data source
+ */
+ private static final String DATA_SOURCES_PROPERTIES_SELECTED_DATA_SOURCE = "selected_datasource"; //$NON-NLS-1$
+
+ /**
+ * Absolute path name for the plug-in specific configuration file.
+ */
+ private static String configFilePath;
+
+ /**
+ * Shared plugin instance.
+ */
+ private static APIQueryPlugin plugin;
+
+ /**
+ * Plugin installation location.
+ */
+ private static String pluginInstallLocation;
+
+ /**
+ * Data Source registry for storing the currently
+ * installed search methods. The registry must be
+ * alive as long as the plugin class is alive.
+ */
+ private static SearchMethodExtensionRegistry smeRegistry = SearchMethodExtensionRegistry.getInstance();
+
+ /**
+ * User settings instance. The settings instance must be
+ * alive as long as the plugin class is alive.
+ */
+ private static UserSettings settings = UserSettings.getInstance();
+
+ /**
+ * Storing preferences
+ */
+ private static IPreferenceStore prefsStore;
+
+ static public boolean isFirstLaunch = false;
+
+ /**
+ * The constructor.
+ */
+ public APIQueryPlugin() {
+ System.out.println("Plugin start");
+ isFirstLaunch = true;
+ plugin = this;
+ DbgUtility.println(DbgUtility.PRIORITY_CLASS, "-- <> --> " + getClass().getName()); //$NON-NLS-1$
+ }
+
+ /**
+ *
+ * @return plugin install path
+ * @throws IOException
+ */
+ public String getPluginInstallPath() throws IOException{
+ // URL to the plugin's root ("/")
+ URL relativeURL = getBundle().getEntry("/"); //$NON-NLS-1$
+ // Converting into local path
+ URL localURL = FileLocator.toFileURL(relativeURL);
+ // Getting install location in correct form
+ File f = new File(localURL.getPath());
+ String pluginInstallLocation = f.getAbsolutePath();
+
+ return pluginInstallLocation;
+ }
+
+ /**
+ * Gets images path relative to given plugin install path.
+ * @return Path were image resources are located.
+ */
+ private String getImagesPath(){
+ return pluginInstallLocation
+ + File.separatorChar
+ + ProductInfoRegistry.getImagesDirectoryName();
+ }
+
+
+
+ /**
+ * This method is called upon plug-in activation
+ */
+ public void start(BundleContext context) throws Exception {
+ super.start(context);
+ //This startup debug println has been left into the code in purpose
+ System.out.println("APIQuery Plugin STARTUP..."); //$NON-NLS-1$
+
+ pluginInstallLocation = getPluginInstallPath();
+
+
+ //This startup debug println has been left into the code in purpose
+ System.out.println("pluginInstallLocation: " + pluginInstallLocation); //$NON-NLS-1$
+
+ // Call to getImagesPath requires that getPluginInstallPath() is
+ // called beforehand.
+ String imagesPath = getImagesPath();
+
+ //This startup debug println has been left into the code in purpose
+ System.out.println("imagesPath: " + imagesPath); //$NON-NLS-1$
+
+ // Seeking for the plugins that extend the SEARCH_METHOD_EXTENSION_POINT_ID
+ fetchExistingSearchMethodExtensionInstances();
+
+ // User settings initialization has to be done after fetching search methods.
+ initializeUserSettings();
+
+
+ }
+
+
+
+
+
+ /**
+ * Returns runtime workspace directory path for the plugin, which
+ * can be used e.g. to store plugin/workspace-specific configuration data.
+ *
+ * @return Workspace directory path for the plugin.
+ */
+ public static String getPluginWorkspacePath(){
+ IPath runtimeWorkspacePath = plugin.getStateLocation();
+ runtimeWorkspacePath.makeAbsolute();
+ return runtimeWorkspacePath.toOSString();
+ }
+
+ /**
+ * Loading the previously stored user settings if any.
+ */
+ private void initializeUserSettings() {
+ // In here will be implemented the load part of the functionality.
+
+ try {
+ String wsPath = getPluginWorkspacePath();
+ configFilePath = wsPath + File.separator + DATA_SOURCES_PROPERTIES_FILE_NAME;
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION, "Data Source's config file: " + configFilePath); //$NON-NLS-1$
+ File configFile = new File(configFilePath);
+ //If User setting has not been chaged, there is no configuration file
+ if(configFile.exists()){
+ Properties props = new Properties();
+ props.load( new FileInputStream(configFile));
+ String currentDataSource = props.getProperty(DATA_SOURCES_PROPERTIES_SELECTED_DATA_SOURCE);
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION, "Currently selected data source is: " +currentDataSource); //$NON-NLS-1$
+
+ //Getting search extension by id
+ ISearchMethodExtension ext = smeRegistry.getById(currentDataSource);
+ //If no errors exist, saving currently selected Data Source to Runtime from propertie file.
+ if(ext != null){
+ ISearchMethodExtensionInfo info = ext.getExtensionInfo();
+ UserSettings.getInstance().setCurrentlySelectedSearchMethodInfo(info);
+ }
+
+ }
+ //If there is no configuration file, we know that this is the first time
+ //user is starting application (at least in this work space, if user is cleaned workspace
+ //or created a new works space he/she might been started application before, but we can't know that).
+ else{
+ //Create a config file by calling userSettingsChanged()
+ userSettingsChanged();
+ //Launching first time popup (quick help)
+ FirstTimePopUpDialog.open(getCurrentlyActiveWbWindowShell());
+
+ }
+ } catch (FileNotFoundException e) {
+ e.printStackTrace();
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Configuration_file_ErrMsg") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ } catch (IOException e) {
+ e.printStackTrace();
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Configuration_file_ErrMsg") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ }catch (Exception e) {
+ e.printStackTrace();
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Configuration_file_ErrMsg") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ }
+ }
+
+
+
+ /**
+ * Seeking for the plugins that extend the SEARCH_METHOD_EXTENSION_POINT_ID
+ * and registering them to the SearchMethodExtensionRegistry.
+ */
+ private void fetchExistingSearchMethodExtensionInstances() {
+
+ try {
+
+ System.out.println("Fetching for search method extensions..."); //$NON-NLS-1$
+ // Searching for search method extensions
+ IExtensionRegistry extensionReg = Platform.getExtensionRegistry();
+ IExtensionPoint extPoint = extensionReg
+ .getExtensionPoint(SEARCH_METHOD_EXTENSION_POINT_ID);
+ IExtension[] searchMethods = extPoint.getExtensions();
+ for (int i = 0; i < searchMethods.length; i++) {
+ IExtension ext = searchMethods[i];
+ IConfigurationElement[] configElements = ext
+ .getConfigurationElements();
+ for (int j = 0; j < configElements.length; j++) {
+ IConfigurationElement configElem = configElements[j];
+
+ String searchMethodClassFullName = configElem.getAttribute(CLASS_ATTRIBUTE);
+
+ try {
+ // Creating search method extension intance
+ Object classInstance = configElem
+ .createExecutableExtension(CLASS_ATTRIBUTE);
+
+ ISearchMethodExtension searchMethod = (ISearchMethodExtension) classInstance;
+
+ System.out.println("Found search method: " //$NON-NLS-1$
+ + searchMethod.getClass().getName());
+
+ ISearchMethodExtensionInfo info = searchMethod.getExtensionInfo();
+
+ System.out.println("\t id: " + info.getId()); //$NON-NLS-1$
+ System.out.println("\t description: " //$NON-NLS-1$
+ + info.getDescription());
+
+ boolean isDefault = info.isDefault();
+ System.out.println("\t isDefault: " //$NON-NLS-1$
+ + isDefault);
+
+ // Adding the extension to local extension registry
+ smeRegistry.addExtension(searchMethod);
+ } catch (Exception e) {
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Search_Method_Instantiate_Failed_Msg_Start") //$NON-NLS-1$
+ + searchMethodClassFullName
+ + Messages.getString("APIQueryPlugin.Search_Method_Instantiate_Failed_Msg_End") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ e.printStackTrace();
+ }
+ }
+ }
+ } catch (Exception e) {
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Search_Method_Instantiate_Failed_Console_Msg") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ e.printStackTrace();
+ }
+
+ if(!(smeRegistry.getExtensionCount() > 0)){
+ String errMsg = Messages.getString("APIQueryPlugin.No_Search_Method_Installed_ErrorMsg_Start") //$NON-NLS-1$
+ + ProductInfoRegistry.getProductName() + Messages.getString("APIQueryPlugin.No_Search_Method_Installed_ErrorMsg_End"); //$NON-NLS-1$
+ APIQueryConsole.getInstance().println(errMsg, IConsolePrintUtility.MSG_ERROR);
+ new APIQueryMessageBox(errMsg, SWT.ICON_ERROR | SWT.OK).open();
+ throw new RuntimeException(errMsg);
+ }
+
+ // Finding out the search method that is selected initally
+ setCurrentlySelectedSearchMethod(smeRegistry.getExtensions());
+
+
+ // Listening further changes in the user settings.
+ settings.addUserSettingListener(this);
+ }
+
+ /**
+ * Sets the default search method as the currently selected search method
+ * if there is no previous user preference.
+ * @param searchMethodExtensions
+ */
+ private void setCurrentlySelectedSearchMethod(Collection searchMethodExtensions) {
+
+ // Querying for the current user preference
+ ISearchMethodExtensionInfo userSelectedExtensionInfo = settings.getCurrentlySelectedSearchMethodInfo();
+
+ // The result of the decision process is stored into the following variable
+ ISearchMethodExtensionInfo selectedExtInfo = null;
+
+ if(userSelectedExtensionInfo == null){
+
+ // There were no previous user settings existing
+
+ // If there is no existing user preference, we select
+ // among the available search methods.
+ //
+ // Current decision algorithm is to select the first one
+ // from the list that has default status. If no search
+ // methods with default status were not found settings,
+ // the last search method found is set as default.
+
+ for (ISearchMethodExtension ext : searchMethodExtensions) {
+ selectedExtInfo = ext.getExtensionInfo();
+
+ if(selectedExtInfo.isDefault()){
+ break;
+ }
+ }
+ }
+ else{
+
+ // There was a previous user preference
+
+ // Browsing through the extension list and setting as default
+ // the search that has the id equal with the user preference.
+ //
+ // If no search methods that match with the user preference
+ // the last search method found is set as default.
+
+ for (ISearchMethodExtension ext : searchMethodExtensions) {
+ selectedExtInfo = ext.getExtensionInfo();
+
+ if(selectedExtInfo.hasEqualId(settings.getCurrentlySelectedSearchMethodInfo())){
+ break;
+ }
+ }
+
+ }
+
+ settings.setCurrentlySelectedSearchMethodInfo(selectedExtInfo);
+ }
+
+ /**
+ * This method is called when the plug-in is stopped
+ */
+ public void stop(BundleContext context) throws Exception {
+ super.stop(context);
+ smeRegistry.notifyPluginShutdown();
+ plugin = null;
+ }
+
+ /**
+ * Returns the shared instance.
+ */
+ public static APIQueryPlugin getDefault() {
+ return plugin;
+ }
+
+ /**
+ * Returns an image descriptor for the image file at the given
+ * plug-in relative path.
+ *
+ * @param path the path
+ * @return the image descriptor
+ */
+ public static ImageDescriptor getImageDescriptor(String path) {
+ return AbstractUIPlugin.imageDescriptorFromPlugin("com.nokia.s60tools.apiquery.plugin", path); //$NON-NLS-1$
+ }
+
+ /**
+ * This must be called from UI thread. If called
+ * from non-ui thread this returns null.
+ * @return Currently active workbench page.
+ */
+ public static IWorkbenchPage getCurrentlyActivePage(){
+ return getDefault().getWorkbench().getActiveWorkbenchWindow().getActivePage();
+ }
+
+ /**
+ * This must be called from UI thread. If called
+ * from non-ui thread this returns null.
+ * @return The shell of the currently active workbench window..
+ */
+ public static Shell getCurrentlyActiveWbWindowShell(){
+ IWorkbenchPage page = getCurrentlyActivePage();
+ if(page != null){
+ return page.getWorkbenchWindow().getShell();
+ }
+ return null;
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.plugin.AbstractUIPlugin#initializeImageRegistry(org.eclipse.jface.resource.ImageRegistry)
+ */
+ protected void initializeImageRegistry(ImageRegistry imgReg) {
+
+ //
+ // Storing images to plugin's image registry
+ //
+ Display disp = Display.getCurrent();
+ Image img = null;
+
+ img = new Image( disp, getImagesPath() + "\\apiquery_tsk.png" ); //$NON-NLS-1$
+ imgReg.put( ImageKeys.IMG_APP_ICON, img );
+
+ img = new Image( disp, getImagesPath() + "\\apiquery_wiz.png" ); //$NON-NLS-1$
+ imgReg.put( ImageKeys.IMG_APP_WIZARD_ICON, img );
+
+ }
+
+ /**
+ * Returns image descriptor for the given key from the plugin's image registry.
+ * @param key Key to search descriptor for.
+ * @return Image descriptor for the given key from the plugin's image registry.
+ */
+ public static ImageDescriptor getImageDescriptorForKey( String key ){
+ ImageRegistry imgReg = getDefault().getImageRegistry();
+ return imgReg.getDescriptor( key );
+ }
+
+ /**
+ * Returns image for the given key from the plugin's image registry.
+ * @param key Key to search image for.
+ * @return Image for the given key from the plugin's image registry.
+ */
+ public static Image getImageForKey( String key ){
+ ImageRegistry imgReg = getDefault().getImageRegistry();
+ return imgReg.get(key);
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.settings.IUserSettingsListener#userSettingsChanged()
+ * Saves selected Data Source to configuration file.
+ */
+ public void userSettingsChanged() {
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION, getClass().getName() + ": User settings has been changed!"); //$NON-NLS-1$
+
+ //Saving selected Data Source Id to .properties file
+ try {
+ File configFile = new File(configFilePath);
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION, "API Query loading Data Source's configuration"); //$NON-NLS-1$
+ Properties props = new Properties();
+ String value = UserSettings.getInstance().getCurrentlySelectedSearchMethodInfo().getId();
+ props.put(DATA_SOURCES_PROPERTIES_SELECTED_DATA_SOURCE, value);
+ props.store(new FileOutputStream(configFile), Messages.getString("APIQueryPlugin.DefaultDataSourceSelByUser_Msg") ); //$NON-NLS-1$
+ } catch (FileNotFoundException e) {
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Configuration_file_ErrMsg") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ e.printStackTrace();
+ } catch (IOException e) {
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Configuration_file_ErrMsg") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ e.printStackTrace();
+ }catch (Exception e) {
+ APIQueryConsole.getInstance().println(Messages.getString("APIQueryPlugin.Configuration_file_ErrMsg") //$NON-NLS-1$
+ + e.getMessage() , IConsolePrintUtility.MSG_ERROR);
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ * Returns the PreferenceStore where plugin preferences are stored
+ *
+ * @return the PreferenceStore where plugin preferences are stored
+ */
+ public static IPreferenceStore getPrefsStore() {
+ if (prefsStore == null){
+ prefsStore = getDefault().getPreferenceStore();
+ }
+
+ return prefsStore;
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/preferences/APIQueryPreferenceConstants.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/preferences/APIQueryPreferenceConstants.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,50 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.preferences;
+
+
+/**
+ * Class for storing keys to preferences.
+ */
+public class APIQueryPreferenceConstants {
+
+
+
+ /**
+ * true value
+ */
+ public static final String TRUE = "true"; //$NON-NLS-1$
+
+ /**
+ * false value
+ */
+ public static final String FALSE = "false"; //$NON-NLS-1$
+
+
+ /**
+ * preference DB key for Show only API Names in search results
+ */
+ public static final String SHOW_ONLY_APINAMES = "apiQueryShowOnlyApiNames"; //$NON-NLS-1$
+
+ /**
+ * preference DB key for showing data source on results or not
+ */
+ public static final String SHOW_DATASOURCE_IN_RESULTS = "apiQueryShowDataSourceInResults"; //$NON-NLS-1$
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/preferences/APIQueryPreferenceInitializer.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/preferences/APIQueryPreferenceInitializer.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,41 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.preferences;
+
+
+import org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer;
+
+import com.nokia.s60tools.apiquery.shared.plugin.APIQueryPlugin;
+
+/**
+ * Class used to initialize default preference values.
+ */
+public class APIQueryPreferenceInitializer extends AbstractPreferenceInitializer {
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer#initializeDefaultPreferences()
+ */
+ public void initializeDefaultPreferences() {
+
+ APIQueryPlugin.getPrefsStore().setDefault(APIQueryPreferenceConstants.SHOW_DATASOURCE_IN_RESULTS, true);
+ }
+}
+
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/preferences/APIQueryPreferences.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/preferences/APIQueryPreferences.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,84 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.preferences;
+
+import org.eclipse.jface.preference.IPreferenceStore;
+
+import com.nokia.s60tools.apiquery.shared.plugin.APIQueryPlugin;
+
+/**
+ * Helper class to use Dependency Explorer preferences. Use this class for accessing DE preferences
+ * instead of accessing directly through {@link org.eclipse.jface.util.IPropertyChangeListener.IPreferenceStore}.
+ */
+public class APIQueryPreferences {
+
+
+
+ /**
+ * Get "Show only API names" value
+ * @return true if preference "Show only API names" is cheked, false otherwise.
+ */
+ public static boolean getShowOnlyAPINames(){
+
+ String value = APIQueryPlugin.getPrefsStore().getString(APIQueryPreferenceConstants.SHOW_ONLY_APINAMES);
+ if(value != null && value.equalsIgnoreCase(APIQueryPreferenceConstants.TRUE)){
+ return true;
+ }else{
+ return false;
+ }
+
+ }
+
+ /**
+ * Set "Show only API names" value
+ * @param isDontAskAgainChecked true if "Show only API names" is selected, false otherwise.
+ */
+ public static void setShowOnlyAPINames(boolean isShowOnlyAPINamesChecked){
+
+ IPreferenceStore store = APIQueryPlugin.getPrefsStore();
+
+ if(isShowOnlyAPINamesChecked){
+ store.setValue(APIQueryPreferenceConstants.SHOW_ONLY_APINAMES, APIQueryPreferenceConstants.TRUE);
+ }else{
+ store.setValue(APIQueryPreferenceConstants.SHOW_ONLY_APINAMES, APIQueryPreferenceConstants.FALSE);
+ }
+ }
+
+ /**
+ * Get "Show Data Source in results" value
+ * @return true if preference "Show Data Source in results" is cheked, false otherwise.
+ */
+ public static boolean getShowDataSourceInResults(){
+
+ boolean value = APIQueryPlugin.getPrefsStore().getBoolean(APIQueryPreferenceConstants.SHOW_DATASOURCE_IN_RESULTS);
+ return value;
+
+ }
+
+ /**
+ * Set "Show Data Source in results" value
+ * @param isDontAskAgainChecked true if "Show Data Source in results" is selected, false otherwise.
+ */
+ public static void setShowDataSourceInResults(boolean isShowDataSourceInResultsChecked){
+
+ IPreferenceStore store = APIQueryPlugin.getPrefsStore();
+ store.setValue(APIQueryPreferenceConstants.SHOW_DATASOURCE_IN_RESULTS, isShowDataSourceInResultsChecked);
+ }
+
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/resources/ImageKeys.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/resources/ImageKeys.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,27 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.resources;
+
+/**
+ * Lists the images keys used store and access images from plugin's image registry.
+ */
+public class ImageKeys {
+ public final static String IMG_APP_ICON = "APIQUERY_IMG_APP_ICON"; //$NON-NLS-1$
+ public final static String IMG_APP_WIZARD_ICON = "APIQUERY_IMG_APP_WIZARD_ICON"; //$NON-NLS-1$
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/resources/Messages.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/resources/Messages.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,47 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.resources;
+
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+
+/**
+ * Class to get messages from localization file
+ */
+public class Messages {
+ private static final String BUNDLE_NAME = "com.nokia.s60tools.apiquery.shared.resources.messages"; //$NON-NLS-1$
+
+ private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
+ .getBundle(BUNDLE_NAME);
+
+ private Messages() {
+ }
+
+ /**
+ * Get message by key
+ * @param key
+ * @return message
+ */
+ public static String getString(String key) {
+ try {
+ return RESOURCE_BUNDLE.getString(key);
+ } catch (MissingResourceException e) {
+ return '!' + key + '!';
+ }
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/resources/messages.properties
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/resources/messages.properties Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,165 @@
+#
+# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+# All rights reserved.
+# This component and the accompanying materials are made available
+# under the terms of "Eclipse Public License v1.0"
+# which accompanies this distribution, and is available
+# at the URL "http://www.eclipse.org/legal/epl-v10.html".
+#
+# Initial Contributors:
+# Nokia Corporation - initial contribution.
+#
+# Contributors:
+#
+# Description:
+#
+#
+MainView.Search_Tab_Title=Search
+MainView.Properties_Tab_Title=Properties
+APIQueryPlugin.Configuration_file_ErrMsg=Failed to load/save Data Source configuration file - reason:
+APIQueryPlugin.DefaultDataSourceSelByUser_Msg=Default Data Source, selected by user.
+APIQueryParameters.UnsupportedQueryType_Msg=Unsupported query type:
+APIQueryParameters.SubsystemName_Msg=Subsystem name
+APIQueryParameters.HeaderName_Msg=Header name
+APIQueryParameters.CR_PS_Name_Msg=CR/P&&S key name
+APIQueryParameters.QueryTypePart1_ErrMsg=Given query type '
+APIQueryParameters.QueryTypePart2_ErrMsg=' cannot be mapped to any description\!
+APIQueryPlugin.Search_Method_Instantiate_Failed_Msg_Start=Failed to instantiate '
+APIQueryPlugin.Search_Method_Instantiate_Failed_Msg_End=' search method extension - reason:
+APIQueryPlugin.Search_Method_Instantiate_Failed_Console_Msg=Failed to fetch search method extensions - reason:
+APIQueryPlugin.No_Search_Method_Installed_ErrorMsg_Start=There were no search method extension plugins installed. Cannot start
+APIQueryPlugin.No_Search_Method_Installed_ErrorMsg_End=\ tool.
+XMLDataSAXHandler.XML_Parse_Error_ConsoleMsg=XML Parsing error encountered:
+XMLDataSAXHandler.XML_Parse_FatalError_ConsoleMsg=XML Parsing fatal error encountered:
+XMLDataSAXHandler.XML_Parse_Warning_ConsoleMsg=XML Parsing warning encountered:
+SearchMethodExtensionRegistry.Failed_To_Add_Ext_ConsoleMsg=Failed to add extension\!
+SearchMethodExtensionRegistry.Extension_Prefix=Extension '
+SearchMethodExtensionRegistry.Is_Registered_Already_MsgPostfix=' is registered already\!
+SearchMethodExtensionRegistry.Failed_To_Remove_Ext_ConsoleMsg=Failed to remove extension\!
+CheckIdentifierAction.Query_Failed_From_Context_Menu_ErrorMsg=Failed to start API query from context menu:
+SearchTabComposite.API_Query_ErrMsg=API query failed:
+QueryTypeSelectionComposite.Query_By_Msg=Query by:
+QueryResultsComposite.SearchResults_Msg=Search results
+QueryResultsComposite.ShowOnlyAPINames_MSg=Show only API names
+QueryTypeSelectionComposite.Query_Type_Was_Not_Selected_Msg=Query type was not selected\!
+QueryTypeSelectionComposite.Not_Supported_ErrMsg=The query type is not supported by the currently selected search method.
+QueryResultsComposite.APIDetailsQueryFailde_ErrMsg=API details query failed:
+QueryTypeSelectionComposite.Query_Type_Not_Available_ErrMsg=The query type is not available for the currently selected search method.
+FirstTimePopUpDialog.Title_Msg="API Query - Quick Help"
+FirstTimePopUpDialog.Topic_Msg=Welcome to use API Query!
+FirstTimePopUpDialog.Tool_Is_For_Msg=API Query is a tool for searching information about APIs.
+FirstTimePopUpDialog.Properties_Msg_Configure=To configure Data Sources, open the Properties tab at the bottom of the API Query view.
+FirstTimePopUpDialog.Properties_Msg_Option_Three_DataSources=Three types of Data Sources are currently available: %s, %s and %s.
+FirstTimePopUpDialog.Properties_Msg_Option_Two_DataSources=Two types of Data Sources are currently available: %s and %s.
+FirstTimePopUpDialog.Properties_Msg_Option_One_DataSources=One type of Data Source is currently available: %s.
+FirstTimePopUpDialog.Properties_Msg_WebDescription=There are three Web servers configured by default, but only two of them are enabled.
+FirstTimePopUpDialog.Seach_Msg=To search for APIs, type the query string into the Search string field on the Search tab. Leaving this field empty will search for all items, which may take a long time.
+FirstTimePopUpDialog.Results_Msg=When APIs are found, click the search results to get more detailed information about them.
+FirstTimePopUpDialog.Project_Query_Msg=API Query for one file or a whole project can be started by right-clicking the .c, .cpp, .h or .hpp file, or on the project/folder node in Package Explorer. API Query for a project will be saved to a file and it contains information about the APIs used in the project.
+FieldMappingRules.NoMappingRule_ErrMsg=No mapping rule was defined for key:
+FindFileFromFoldersJob.CancelledByUser_Msg=Cancelled by user
+FindFileFromFoldersJob.ErrorOnSeekin_StatusMsg_Part1=Error seeking file:
+FindFileFromFoldersJob.ErrorOnSeekin_StatusMsg_Part2=\ from SDK:
+FindFileFromFoldersJob.ErrorSeekingFile_ErrMsg_Part1=Error seeking file:
+FindFileFromFoldersJob.ErrorSeekingFile_ErrMsg_Part2=\ from SDK:
+FindFileFromFoldersJob.ErrorSeekingFileWithValue_ErrMsg_Part1=Error seeking file:
+FindFileFromFoldersJob.ErrorSeekingFileWithValue_ErrMsg_Part2=\ from SDK:
+FindFileFromFoldersJob.ErrorSeekingFileWithValue_ErrMsg_Part3=. Exit value was:
+FindFileFromFoldersJob.FileFound_Progress_Msg_Part1=File: '
+FindFileFromFoldersJob.FileFound_Progress_Msg_Part2=' found.
+FirstTimePopUpDialog.More_Information_Msg=More instructions are available in API Query help. To open the help, go to Help > Help Contents, then select Carbide Tools > API Query.
+ActiveProjectQueryJob.StartingToRun_Msg=Starting to run
+ActiveProjectQueryJob.Title_Project_Msg=Project
+ActiveProjectQueryJob.ErrorsOnJob_ErrMsg=Errors on job:
+ActiveProjectQueryJob.TaskStarted_Msg=Started
+ActiveProjectQueryJob.APIQueryForProject_Msg=API query for project: '
+ActiveProjectQueryJob.APIQueryForProject_OnProgress_Part2_Msg=' on progress...
+ActiveProjectQueryJob.Progresbar_Step1_Msg=Searching included headers from project.
+ActiveProjectQueryJob.Progresbar_Step2_Msg=Getting information of used APIs.
+ActiveProjectQueryJob.Progresbar_Step3_Msg=Getting API Details from selected Search Method.
+ActiveProjectQueryJob.Progresbar_Step4_Msg=Generating report.
+ActiveProjectQueryJob.CouldNotGetAPISUmmaries_ErrMsg=Could not get API summaries.
+ActiveProjectQueryJob.Title_IsUsingFollowingAPIs_Msg=\ is using following APIs and headers in files
+ActiveProjectQueryJob.Progresbar_Done_Msg=Done
+ActiveProjectQueryJob.APIQueryForProject_Compeleated_Msg=' compleated.
+ActiveProjectQueryJob.Starting_Part1_Msg=Starting '
+ActiveProjectQueryJob.Starting_Part2_Msg=' query to project '
+ActiveProjectQueryJob.Starting_Part3_Msg=' with search string '
+ActiveProjectQueryJob.NoDetailsForAPI_Msg=No details for API:
+ActiveProjectQueryJob.APIQueryFailed_ErrMsg=API query errors encountered for following reason(s):
+CheckProjectReport.Unknown_MSg=Unknown
+CheckProjectReport.APIName_Msg=API Name
+CheckProjectReport.NoteForReportLinks_Msg=Note: You can only open links from the report when the API Query Carbide.c++ Extension is running.
+CheckProjectReport.UsingFile_Msg=Using files
+CheckProjectReport.UsedHeader_ErrMsg=Used headers and Using files must be same sized and not null.
+CheckProjectAction.APIQuery_JobName_Msg=API Query
+CheckProjectAction.CannotGenerateReport_ErrMsg=Cannot generate report for project:
+CheckProjectAction.UnableToOpenReport_ErrMsg=Unable to open report, reason:
+CheckProjectReport.UsedHeader_Msg=Used headers
+CheckProjectAction.ExportAPIQueryForProject_Msg=Export API Query for project
+CheckProjectReport.UnableToLoadCSS_Part1_ErrMsg=Unable to get stylesheet from:
+CheckProjectReport.UnableToLoadCSS_Part2_ErrMsg=, error was:
+APIQueryParameters.APIName_Msg=API name
+APIQueryParameters.DLLName_Msg=DLL name
+APIQueryParameters.LIBName_Msg=LIB name
+APIQueryWebServerConfigurator.StartServer_ErrMsg_Part1=Unable to start
+APIQueryWebServerConfigurator.StartServer_ErrMsg_Part2=. Error was:
+APIQueryWebServerConfigurator.StartServer_Msg_Part1=Web server: '
+APIQueryWebServerConfigurator.StartServer_Msg_Part2=' started and running on address: '
+APIQueryWebServerConfigurator.StartServer_Msg_Part3='. API Query report links are now functional.
+APIQueryWebServerConfigurator.StoptServer_ErrMsg_Part1=Unable to stop
+APIQueryWebServerConfigurator.StoptServer_ErrMsg_Part2=. Error was:
+APIQueryWebServerConfigurator.StoptServer_Msg_Part1=Web server: '
+APIQueryWebServerConfigurator.StoptServer_Msg_Part2=' stopped. API Query report links are now unfunctional.
+AbstractEntryStorage.Duplicate_ErrMsg=There cannot exist two entries with the same name
+AbstractJob.JobCancelled_Part1_ErrMsg=Job:
+AbstractJob.JobCancelled_Part2_ErrMsg=\ cancelled by user.
+AbstractJob.Percentage_Complete_Msg=% complete.
+AbstractEntryStorage.NonExistingEntry_ErrMsg=Tried to update a non-existing entry:
+AbstractSearchMethodExtension.UnknownHost_ErrMsg=Unknown host
+AbstractSearchMethodExtension.MalformedURL_ErrMsg=Malformed URL
+AbstractSearchMethodExtension.IOException_ErrMsg=I/O Exception
+AbstractSearchMethodExtension.InvalidXML_ErrMsg=Invalid XML
+AbstractJob.Prosessing_Msg=\ Processing:
+AbstractSearchMethodExtension.UnexpectedException_ErrMsg=Unexpected exception
+AbstractSearchMethodExtension.NoServerEntries_ErrMsg=No server entries configured or selected in Properties-tab.
+AbstractUiFractionComposite.ParentDisplayNULL_ErrMsg=Parent's display is NULL\!\!\!
+OpenFileAction.18=DEBUG: find files
+OpenFileAction.CannotFoundFile_ErrMsg_Part1=File: '
+OpenFileAction.CannotFoundFile_ErrMsg_Part2=' can not be found from project: '
+OpenFileAction.CannotFoundFile_Msg_Part1=File: '
+OpenFileAction.CannotFoundFile_Msg_Part2=' can not be found under SDK: '
+OpenFileAction.JobName_Msg=Seek file:
+OpenFileAction.NotCarbideProject_ErrMsg_Part1=Project: '
+OpenFileAction.NotCarbideProject_ErrMsg_Part2=' is not Carbide project.
+OpenFileAction.ProjectNotExist_ErrMsg_Part1=Project: '
+OpenFileAction.ProjectNotExist_ErrMsg_Part2=' does not exist.
+OpenFileAction.StartingSeek_Msg_Part1=Starting to seek file: '
+OpenFileAction.StartingSeek_Msg_Part2=' from project: '
+OpenFileAction.TargetFound_Msg_Part1=Target SDK: '
+OpenFileAction.TargetFound_Msg_Part2=' for project: '
+OpenFileAction.TargetFound_Msg_Part3=' found, starting to seek file: '
+OpenFileAction.Unexpected_ErrMsg_Part1=Unexpected error occurded when seeking file: '
+OpenFileAction.Unexpected_ErrMsg_Part2=' from project: '
+OpenFileAction.Unexpected_ErrMsg_Part3=\ Error was:
+OpenReportStatusDialog.OpenReport_Msg=Open report
+OpenReportStatusDialog.DoYouWantOpenReport_Msg=Do you want to open created report
+PropertiesTabComposite.DataSource_Msg=Data Source
+PropertiesTabComposite.ShowDataSourceInResults_Msg=Show Data Source in Search results
+QueryDefComposite.SearchString_Msg=Search string:
+QueryResultsComposite.APIDetails_MSg=API details:
+QueryDefComposite.Search_Msg=Search
+QueryResultsComposite.APIs_Msg=match
+QueryResultsComposite.Found_Msg=Found
+QueryResultsComposite.UnableToGetAPIDetails_ErrMsg_Part1=Unable to get API Details for: '
+QueryResultsComposite.UnableToGetAPIDetails_ErrMsg_Part2='. Error was:
+SearchTabUIFieldsMediator.APIListQueryFailed_ErrMsg=API list query errors encountered for following reason(s):
+QueryDefComposite.Context_ErrMsg=Unable to set Context sensitive Help ID:s, error was:
+ReportActionServlet.NotSupportedAction_Msg=API Query report action Servlet called with no valid action.
+ReportActionServlet.NotSupportedQueryType_ErrMsg_Part1=Errors in report, not supported query type: '
+ReportActionServlet.NotSupportedQueryType_ErrMsg_Part2='. Please rerun API Query for Active project.
+ReportActionServlet.NotSupportedSearchMethod_ErrMsg_Part1=Not supported search method: '
+ReportActionServlet.NotSupportedSearchMethod_ErrMsg_Part2=' for selected Data source: '
+ReportActionServlet.Unexpected_ErrMsg_Part1=Unexpected error occur when API Query was started for Search string: '
+ReportActionServlet.Unexpected_ErrMsg_Part2=' with search type: '
+ReportActionServlet.Unexpected_ErrMsg_Part3='. Error was:
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/AbstractSearchMethodExtension.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/AbstractSearchMethodExtension.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,311 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.searchmethod;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.UnknownHostException;
+import java.util.Collection;
+
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IConfigurationElement;
+import org.eclipse.core.runtime.IExecutableExtension;
+import org.eclipse.core.runtime.IProgressMonitor;
+
+import com.nokia.s60tools.apiquery.shared.datatypes.APIDetails;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIQueryParameters;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIShortDescription;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIShortDescriptionSearchResults;
+import com.nokia.s60tools.apiquery.shared.datatypes.config.AbstractEntry;
+import com.nokia.s60tools.apiquery.shared.exceptions.QueryOperationFailedException;
+import com.nokia.s60tools.apiquery.shared.exceptions.XMLNotValidException;
+import com.nokia.s60tools.apiquery.shared.job.JobCancelledByUserException;
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.apiquery.shared.util.xml.XMLUtils;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+/**
+ * Abstract class that provides common services for all search methods.
+ */
+public abstract class AbstractSearchMethodExtension implements ISearchMethodExtension, IExecutableExtension {
+
+ public static final String ID_ATTRIBUTE = "id"; //$NON-NLS-1$
+ public static final String DESCRIPTION_ATTRIBUTE = "description"; //$NON-NLS-1$
+ public static final String IS_DEFAULT_ATTRIBUTE = "isDefault"; //$NON-NLS-1$
+
+ private SearchMethodExtensionInfo extensionInfo;
+
+ /**
+ * The subclasses of this abstract class is created by using createExecutableExtension
+ * method from IConfigurationElement class, and therefore
+ * the constructor cannot have any parameters.
+ * @see org.eclipse.core.runtime.IConfigurationElement#createExecutableExtension
+ */
+ public AbstractSearchMethodExtension(){
+ extensionInfo = new SearchMethodExtensionInfo();
+ }
+
+
+ /* (non-Javadoc)
+ * @see org.eclipse.core.runtime.IExecutableExtension#setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)
+ */
+ public void setInitializationData(IConfigurationElement configElem, String classPropertyName, Object data) throws CoreException {
+ extensionInfo.setId(configElem.getAttribute(ID_ATTRIBUTE));
+ extensionInfo.setDescription(configElem.getAttribute(DESCRIPTION_ATTRIBUTE));
+ extensionInfo.setDefault(Boolean.parseBoolean(configElem.getAttribute(IS_DEFAULT_ATTRIBUTE)));
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension#getExtensionInfo()
+ */
+ public SearchMethodExtensionInfo getExtensionInfo() {
+ return extensionInfo;
+ }
+
+ /**
+ * Throws an exception for user with the given message.
+ * @param errorMsg Main error message for the user.
+ * @param detailedMsg More detailed message shown in parenthesis.
+ * @throws QueryOperationFailedException
+ */
+ protected void queryFailed(String errorMsg, String detailedMsg) throws QueryOperationFailedException {
+ APIQueryConsole.getInstance().println(errorMsg, APIQueryConsole.MSG_ERROR);
+ String combinedMsg = getCombinedMessage(errorMsg, detailedMsg);
+ throw new QueryOperationFailedException(combinedMsg);
+ }
+
+
+ private String getCombinedMessage(String errorMsg, String detailedMsg) {
+ String combinedMsg = errorMsg + " (" + detailedMsg + ")."; //$NON-NLS-1$ //$NON-NLS-2$
+ return combinedMsg;
+ }
+
+ /**
+ * Throws an exception for user with the given message.
+ * @param errorMsg Main error message for the user.
+ * @param detailedMsg More detailed message shown in parenthesis.
+ * @param QueryOperationFailedException
+ * @throws QueryOperationFailedException
+ */
+ private void queryFailed(String errorMsg, String detailedMsg, QueryOperationFailedException e) throws QueryOperationFailedException {
+ APIQueryConsole.getInstance().println(errorMsg, APIQueryConsole.MSG_ERROR);
+ String combinedMsg = getCombinedMessage(errorMsg, detailedMsg);
+ QueryOperationFailedException ex = new QueryOperationFailedException(combinedMsg);
+ ex.setSummarys(e.getSummarys());
+ throw ex;
+ }
+
+ /**
+ * Examines the type of throwable parameter, and adds appropriate
+ * error message or default message, and forwards the information
+ * for further processing.
+ * @param throwable Throwable to be examined.
+ * @throws QueryOperationFailedException
+ */
+ protected void examineAndHandleQueryFailureException(Throwable throwable) throws QueryOperationFailedException{
+
+ String errMsg = Messages.getString("AbstractSearchMethodExtension.UnexpectedException_ErrMsg"); //$NON-NLS-1$
+
+ if(throwable instanceof QueryOperationFailedException) {
+ errMsg = "Query error";
+ queryFailed(errMsg, throwable.getMessage(), (QueryOperationFailedException)throwable);
+ } else{
+ if (throwable instanceof UnknownHostException) {
+ errMsg = Messages.getString("AbstractSearchMethodExtension.UnknownHost_ErrMsg"); //$NON-NLS-1$
+ }
+ else if(throwable instanceof MalformedURLException) {
+ errMsg = Messages.getString("AbstractSearchMethodExtension.MalformedURL_ErrMsg"); //$NON-NLS-1$
+ }
+ else if(throwable instanceof IOException) {
+ errMsg = Messages.getString("AbstractSearchMethodExtension.IOException_ErrMsg"); //$NON-NLS-1$
+ }
+ else if(throwable instanceof XMLNotValidException) {
+ errMsg = Messages.getString("AbstractSearchMethodExtension.InvalidXML_ErrMsg"); //$NON-NLS-1$
+ }
+
+ queryFailed(errMsg, throwable.getMessage());
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension#getAPIDetails(com.nokia.s60tools.apiquery.shared.datatypes.APIShortDescription)
+ */
+ public APIDetails getAPIDetails(APIShortDescription summary) throws QueryOperationFailedException {
+ String detailsXMLData = null;
+ APIDetails details = null;
+
+ try {
+ detailsXMLData = getAPIDetailsAsXML(summary);
+ details = XMLUtils.xmlToAPIDetails(detailsXMLData.toString());
+ } catch (Exception e) {
+ DbgUtility.println(DbgUtility.PRIORITY_CLASS, "###Errors on parsing API Details. API Name was: " //$NON-NLS-1$
+ +summary.getName() +", API source was: " +summary.getSource()); //$NON-NLS-1$
+ e.printStackTrace();
+ examineAndHandleQueryFailureException(e);
+ }
+
+ return details;
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension#runAPIQuery(com.nokia.s60tools.apiquery.shared.datatypes.APIQueryParameters)
+ */
+ public APIShortDescriptionSearchResults runAPIQuery(APIQueryParameters parameters) {
+
+ APIShortDescriptionSearchResults results = new APIShortDescriptionSearchResults();
+
+ // Making query for each configured and selected server entry.
+ AbstractEntry[] selEntryArr = getEntryStorageInstance().getSelectedEntries();
+
+ // Were any entries configured or selected?
+ if(selEntryArr.length == 0){
+ results.addSearchError(new QueryOperationFailedException(Messages.getString("AbstractSearchMethodExtension.NoServerEntries_ErrMsg"))); //$NON-NLS-1$
+ return results;
+ }
+ for (int i = 0; i < selEntryArr.length; i++) {
+ AbstractEntry entry = selEntryArr[i];
+ if(parameters.getSearchString().contains(APIQueryParameters.SEARCH_ITEM_SEPARATOR_CHAR)){
+ //Adding results for results, if there was errors, adding error to results
+ try {
+ results.addSearchResults(handleMultiEntryQuery(parameters, entry));
+ } catch (QueryOperationFailedException e) {
+ results.addSearchError(e);
+ if(e.getSummarys() != null){
+ results.addSearchResults(e.getSummarys());
+ }
+ }
+ }else{
+ //Adding results for results, if there was errors, adding error to results
+ try {
+ results.addSearchResults(handleSingleEntryQuery(parameters, entry));
+ } catch (QueryOperationFailedException e) {
+ results.addSearchError(e);
+ if(e.getSummarys() != null){
+ results.addSearchResults(e.getSummarys());
+ }
+ }
+ }
+ }
+
+ return results;
+ }
+
+ /**
+ * Handles API summary query for a given server entry.
+ * @param parameters Query parameters.
+ * @param srvEntry Entry to be query data from.
+ * @return Collection of API summaries for the given server entry.
+ * @throws QueryOperationFailedException
+ */
+ protected abstract Collection handleSingleEntryQuery(APIQueryParameters parameters, AbstractEntry entry) throws QueryOperationFailedException;
+
+ /**
+ * Handles API summary query for a given server entry.
+ *
+ * Used when search string contains multiple search strings semi-colon (;) separated.
+ * Eg. multiple headers as semi-colon separated.
+ *
+ * Should call when APIQueryParameters.getSearchString().contains(APIQueryParameters.SEARCH_ITEM_SEPARATOR_CHAR)
+ * occurs.
+ *
+ * @param parameters Query parameters. Where getSearchString() contains semi-colons.
+ * @param srvEntry Entry to be query data from.
+ * @return Collection of API summaries for the given server entry.
+ * @throws QueryOperationFailedException
+ */
+ protected abstract Collection handleMultiEntryQuery(APIQueryParameters parameters, AbstractEntry entry) throws QueryOperationFailedException;
+
+
+ //
+ // Abstract methods to be defined by subclasses.
+ //
+
+ /**
+ * Gets API Details as XML formatted string for given summary.
+ * Abstract method that must be implemented by all sub classes.
+ * @param summary API summary data to get details for.
+ * @return API Detail XML data as string.
+ */
+ protected abstract String getAPIDetailsAsXML(APIShortDescription summary) throws Exception;
+
+ /**
+ * Handles API summary query for a given server entry.
+ * @param parameters Query parameters.
+ * @param srvEntry Entry to be query data from.
+ * @return API summaries for the given server entry as XML formatted string.
+ * @throws QueryOperationFailedException
+ */
+ protected abstract String runAPIQueryForSingleEntryAndReturnXMLString(APIQueryParameters parameters, AbstractEntry entry) throws Exception;
+
+
+ /**
+ * Web query job cancellat
+ * @param parameters
+ * @param progressMonitor
+ * @return
+ * @throws JobCancelledByUserException
+ */
+ public APIShortDescriptionSearchResults runAPIQuery(APIQueryParameters parameters,IProgressMonitor progressMonitor)throws JobCancelledByUserException {
+
+
+
+
+ APIShortDescriptionSearchResults results = new APIShortDescriptionSearchResults();
+
+ // Making query for each configured and selected server entry.
+ AbstractEntry[] selEntryArr = getEntryStorageInstance().getSelectedEntries();
+
+
+
+
+ // Were any entries configured or selected?
+ if(selEntryArr.length == 0){
+ results.addSearchError(new QueryOperationFailedException(Messages.getString("AbstractSearchMethodExtension.NoServerEntries_ErrMsg"))); //$NON-NLS-1$
+ return results;
+ }
+ for (int i = 0; i < selEntryArr.length; i++) {
+ AbstractEntry entry = selEntryArr[i];
+ if(parameters.getSearchString().contains(APIQueryParameters.SEARCH_ITEM_SEPARATOR_CHAR)){
+ //Adding results for results, if there was errors, adding error to results
+ try {
+ results.addSearchResults(handleMultiEntryQuery(parameters, entry,progressMonitor));
+ } catch (QueryOperationFailedException e) {
+ results.addSearchError(e);
+ }
+ }else{
+ //Adding results for results, if there was errors, adding error to results
+ try {
+ results.addSearchResults(handleSingleEntryQuery(parameters, entry,progressMonitor));
+ } catch (QueryOperationFailedException e) {
+ results.addSearchError(e);
+ }
+ }
+ }
+
+
+ return results;
+ }
+
+
+
+ protected abstract Collection handleSingleEntryQuery(APIQueryParameters parameters, AbstractEntry entry,IProgressMonitor monitor) throws JobCancelledByUserException,QueryOperationFailedException;
+ protected abstract Collection handleMultiEntryQuery(APIQueryParameters parameters, AbstractEntry entry,IProgressMonitor progressMonitor) throws QueryOperationFailedException,JobCancelledByUserException;
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/ISearchMethodExtension.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/ISearchMethodExtension.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,162 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.searchmethod;
+
+import java.util.Collection;
+import java.util.Hashtable;
+import java.util.Set;
+import org.eclipse.swt.widgets.Composite;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIDetails;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIQueryParameters;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIShortDescription;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIShortDescriptionSearchResults;
+import com.nokia.s60tools.apiquery.shared.datatypes.config.AbstractEntryStorage;
+import com.nokia.s60tools.apiquery.shared.exceptions.QueryOperationFailedException;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ui.AbstractUiFractionComposite;
+
+/**
+ * Interface that has to be implemnted by all
+ * search method instances.
+ */
+public interface ISearchMethodExtension {
+
+ /**
+ * Gets the extension info for the search method.
+ * @return Returns extension info for the search method.
+ */
+ ISearchMethodExtensionInfo getExtensionInfo();
+
+ /**
+ * This method is called when we do not need
+ * the services of this extension. This gives
+ * possibilities for the extension to make
+ * any shutdown related operations it sees
+ * as necessary.
+ */
+ public void notifyExtensionShutdown();
+
+ /**
+ * Returns the search method specific configuration UI as
+ * UI Composite that can be disposed and re-created whenever needed.
+ * @param parent Parent composite for the created configuration UI.
+ * @return Returns the search method specific configuration UI.
+ */
+ public AbstractUiFractionComposite createExtensionConfigurationUi(Composite parent);
+
+ /**
+ * Runs API Query with the given parameters.
+ * Throws QueryOperationFailedException if something failed
+ * during query operation.
+ * @param parameters Parameters guiding the query.
+ * @return APIShortDescriptionSearchResults containing Collection of API summary objects
+ * for the APIs found based on the query and possible QueryOperationFailedException search errors Collection.
+ */
+ public APIShortDescriptionSearchResults runAPIQuery(APIQueryParameters parameters);
+
+ /**
+ * Gets API details for the given API.
+ * Throws QueryOperationFailedException if something failed
+ * during query operation.
+ * @param summary API summary object to get details for.
+ * @return API details for the given summary object.
+ * @throws QueryOperationFailedException
+ */
+ public APIDetails getAPIDetails(APIShortDescription summary) throws QueryOperationFailedException;
+
+ /**
+ * Gets API details for the given APIs.
+ * Throws QueryOperationFailedException if something failed
+ * during query operation.
+ * @param list of API summary objects to get details for.
+ * @return API details for the given summary objects. Given API name as key and APIDetails as value.
+ * If cant found or parse a Details, an empty Details is added to collection.
+ * @throws QueryOperationFailedException
+ */
+ Hashtable getAPIDetails(Collection apis) throws QueryOperationFailedException;
+
+
+ /**
+ * Can be used to check if a certain query type
+ * is supported by the search method.
+ * @param queryType Query type defined in APIQueryParameters to be checked.
+ * @return true if the query type is supported, otherwise false.
+ * @see APIQueryParameters#QUERY_BY_API_NAME
+ * @see APIQueryParameters#QUERY_BY_SUBSYSTEM_NAME
+ * @see APIQueryParameters#QUERY_BY_DLL_NAME
+ * @see APIQueryParameters#QUERY_BY_LIB_NAME
+ * @see APIQueryParameters#QUERY_BY_HEADER_NAME
+ * @see APIQueryParameters#QUERY_BY_CRPS_KEY_NAME
+ */
+ public boolean isSupportedQueryType(int queryType);
+
+ /**
+ * Returns search method specific configuration storage instance.
+ * @return Data Source specific configuration storage instance.
+ */
+ public AbstractEntryStorage getEntryStorageInstance();
+
+ /**
+ * Get API details to show in report.
+ * @return API Detail topics to be shown in report
+ */
+ public String[] getAPIDetailsToReport(Set usedAPIs, Hashtable projectUsingAPIDetails);
+
+ /**
+ * Maps query type to API Detail topic in API Details.
+ * @param queryType Query type constant.
+ * @return Name of the API Detail.
+ */
+ public String getAPIDetailNameInDetailsByQueryType(int queryType);
+
+ /**
+ * Maps API Detail topic in API Details to query type.
+ * @param queryType Query type constant.
+ * @return Query type int described in {@link APIQueryParameters} or -1 if not supported.
+ */
+ public int getQueryTypeByAPIDetailNameInDetails(String queryType);
+
+ /**
+ *
+ * @return true for web query and false for other data sources
+ */
+ public boolean isAsyncQueryPreferred();
+
+ /**
+ * if it's for a header serach,then should the headerlink be enabled so that user can click on it and open it.
+ */
+ public boolean serachHeaderLinkEnable();
+
+/**
+ * opens the supplied header file.Provide an implementation if headerlink is enabled.
+ * @param header : header name
+ * @param source : APIShortDescription.getSource()
+ * @return 0-successfully opened , 1-error
+ */
+ public int openHeaderFile(String headerName,String source);
+
+ /*
+ *
+ */
+ public String[] getHeaderSourceList();
+
+
+
+
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/ISearchMethodExtensionInfo.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/ISearchMethodExtensionInfo.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,51 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.searchmethod;
+
+/**
+ * Stores the informative metadata for
+ * a search method extension.
+ */
+public interface ISearchMethodExtensionInfo {
+ /**
+ * Gets the id of the search method.
+ * @return Id of the search method.
+ */
+ public String getId();
+
+ /**
+ * Gets the description for the search method.
+ * @return Description for the search method.
+ */
+ public String getDescription();
+
+ /**
+ * Checks if this search method is the default one, unless
+ * otherwise decided according user settings.
+ * @return Returns true if this search method is the default one,
+ * otherwise returns false.
+ */
+ public boolean isDefault();
+
+ /**
+ * Compares the Id's of the two search methods
+ * @return true if the two search Ids match, otherwise false.
+ */
+ public boolean hasEqualId(ISearchMethodExtensionInfo extInfo);
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/SearchMethodExtensionInfo.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/SearchMethodExtensionInfo.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,81 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.searchmethod;
+
+public class SearchMethodExtensionInfo implements ISearchMethodExtensionInfo{
+
+ private String id;
+ private String description;
+ private boolean isDefault;
+
+ public SearchMethodExtensionInfo(){
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.searchmethodregistry.ISearchMethodExtensionInfo#getDescription()
+ */
+ public String getDescription() {
+ return description;
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.searchmethodregistry.ISearchMethodExtensionInfo#getId()
+ */
+ public String getId() {
+ return id;
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.searchmethodregistry.ISearchMethodExtensionInfo#isDefault()
+ */
+ public boolean isDefault() {
+ return isDefault;
+ }
+
+ /**
+ * Sets the description.
+ * @param description The description to set.
+ */
+ public void setDescription(String description) {
+ this.description = description;
+ }
+
+ /**
+ * Sets the id.
+ * @param id The id to set.
+ */
+ public void setId(String id) {
+ this.id = id;
+ }
+
+ /**
+ * Sets the isDefault status.
+ * @param isDefault The isDefault to set.
+ */
+ public void setDefault(boolean isDefault) {
+ this.isDefault = isDefault;
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.searchmethodregistry.ISearchMethodExtensionInfo#hasEqualId(com.nokia.s60tools.apiquery.searchmethodregistry.ISearchMethodExtensionInfo)
+ */
+ public boolean hasEqualId(ISearchMethodExtensionInfo extInfo) {
+ return this.getId().equalsIgnoreCase(extInfo.getId());
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/ui/AbstractUiFractionComposite.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethod/ui/AbstractUiFractionComposite.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,116 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.searchmethod.ui;
+
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Layout;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+
+/**
+ * Abstract class that defines an abstract template
+ * for the composites that should be used to populate
+ * the contents a tab area or a sub area inside a tab
+ * (or inside any other UI element). Just utilizing
+ * Eclipse UI functionality, but making it simpler
+ * and more compact to use UI Composites from at the
+ * source code level.
+ */
+public abstract class AbstractUiFractionComposite extends Composite {
+
+ /**
+ * Constructor.
+ * @param parentComposite Parent composite for the created composite.
+ * @param style The used style for the composite.
+ */
+ public AbstractUiFractionComposite(Composite parentComposite, int style) {
+ super(parentComposite, style);
+ checkParent(parentComposite);
+ initComposite();
+ }
+
+ /**
+ * Checks that parent has a valid display.
+ * @param parentComposite Parent composite for the created composite.
+ */
+ private void checkParent(Composite parentComposite) {
+ if (parentComposite.getDisplay() == null){
+ throw new RuntimeException(Messages.getString("AbstractUiFractionComposite.ParentDisplayNULL_ErrMsg")); //$NON-NLS-1$
+ }
+ }
+
+ /**
+ * Constructor.
+ * @param parentComposite Parent composite for the created composite.
+ */
+ public AbstractUiFractionComposite(Composite parentComposite) {
+ super(parentComposite, SWT.NONE);
+ initComposite();
+ }
+
+ /**
+ * Performs template methods that take care
+ * of finalizing composite construction.
+ */
+ private void initComposite(){
+ setLayout(createLayout());
+ setLayoutData(createLayoutData());
+ createControls();
+ }
+
+ /**
+ * Sub classes can override this.
+ * @return Width hint for the composite.
+ */
+ public int getWidthHint(){
+ return SWT.DEFAULT;
+ }
+
+ /**
+ * Sub classes can override this.
+ * @return Height hint for the composite.
+ */
+ public int getHeightHint(){
+ return SWT.DEFAULT;
+ }
+
+ /**
+ * Template method to be implementd in sub classes.
+ * Sub class should initialize the composite's layout
+ * in the implementation of this method.
+ * @return Layout for the composite.
+ */
+ protected abstract Layout createLayout();
+
+ /**
+ * Template method to be implementd in sub classes.
+ * Sub class should initialize the composite's layout data
+ * in the implementation of this method.
+ * @return Layout for the composite.
+ */
+ protected abstract Object createLayoutData();
+
+ /**
+ * Template method to be implementd in sub classes.
+ * Sub class should create all the composite's controls
+ * in the implementation of this method.
+ */
+ protected abstract void createControls();
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethodregistry/SearchMethodExtensionRegistry.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/searchmethodregistry/SearchMethodExtensionRegistry.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,170 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.searchmethodregistry;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtensionInfo;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.util.console.IConsolePrintUtility;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+
+
+
+/**
+ * Singleton class that is created on plugin
+ * startup, and is kept active as long as plugin is active.
+ *
+ * The purpose of this class is to store search method
+ * extensions that were found from the system.
+ */
+public class SearchMethodExtensionRegistry {
+
+ /**
+ * Singleton instance.
+ */
+ static private SearchMethodExtensionRegistry instance = null;
+
+ /**
+ * Listeners interested in job completions operations.
+ */
+ private static Map extensions = Collections.synchronizedMap(new HashMap());
+
+ /**
+ * Public Singleton instance accessor.
+ * @return Returns instance of this singleton class-
+ */
+ public static SearchMethodExtensionRegistry getInstance(){
+ if( instance == null ){
+ instance = new SearchMethodExtensionRegistry();
+ }
+ return instance;
+ }
+
+ /**
+ * Private default constructor.
+ */
+ private SearchMethodExtensionRegistry() {
+ DbgUtility.println(DbgUtility.PRIORITY_CLASS, "-- <> --> " + getClass().getName()); //$NON-NLS-1$
+ }
+
+ /**
+ * Add a new Search Method
+ * @param extension
+ */
+ public void addExtension(ISearchMethodExtension extension){
+ synchronized(extensions){
+ ISearchMethodExtensionInfo info = extension.getExtensionInfo();
+ String id = info.getId();
+ ISearchMethodExtension possibleDuplicate = extensions.get(id);
+ if( possibleDuplicate != null ){
+ String errMsg = Messages.getString("SearchMethodExtensionRegistry.Failed_To_Add_Ext_ConsoleMsg") //$NON-NLS-1$
+ + Messages.getString("SearchMethodExtensionRegistry.Extension_Prefix") //$NON-NLS-1$
+ + id
+ + Messages.getString("SearchMethodExtensionRegistry.Is_Registered_Already_MsgPostfix"); //$NON-NLS-1$
+ APIQueryConsole.getInstance().println(errMsg, IConsolePrintUtility.MSG_ERROR);
+ throw new RuntimeException(errMsg);
+ }
+ extensions.put(id, extension);
+ } // synchronized
+ }
+
+ /**
+ * Remove a Search Method
+ * @param extension
+ */
+ public void removeExtension(ISearchMethodExtension extension){
+ synchronized(extensions){
+ ISearchMethodExtensionInfo info = extension.getExtensionInfo();
+ String id = info.getId();
+ ISearchMethodExtension possibleDuplicate = extensions.get(id);
+ if( possibleDuplicate == null ){
+ String errMsg = Messages.getString("SearchMethodExtensionRegistry.Failed_To_Remove_Ext_ConsoleMsg") //$NON-NLS-1$
+ + Messages.getString("SearchMethodExtensionRegistry.Extension_Prefix") //$NON-NLS-1$
+ + id
+ + Messages.getString("SearchMethodExtensionRegistry.Is_Registered_Already_MsgPostfix"); //$NON-NLS-1$
+ APIQueryConsole.getInstance().println(errMsg, IConsolePrintUtility.MSG_ERROR);
+ throw new RuntimeException(errMsg);
+ }
+ extension.notifyExtensionShutdown();
+ extensions.remove(extension);
+ } // synchronized
+ }
+
+ /**
+ * Called before host plugin shutdown.
+ */
+ public void notifyPluginShutdown(){
+ for (ISearchMethodExtension ext : getExtensions()) {
+ ext.notifyExtensionShutdown();
+ }
+ }
+
+ /**
+ * Returns the iterator for the currently registered extensions.
+ * @return Returns the currently registered extensions.
+ */
+ public Collection getExtensions(){
+ return extensions.values();
+ }
+
+ /**
+ * Gets the amount of currently registered extensions.
+ * @return Returns the amount of currently registered extensions.
+ */
+ public int getExtensionCount(){
+ return getExtensions().size();
+ }
+
+ /**
+ * Gets the extension that matches with the given description.
+ * @param extensionDescription Description of the search method.
+ * @return The extension matching the description or null if not found.
+ */
+ public ISearchMethodExtension getByDescription(String extensionDescription) {
+ for (ISearchMethodExtension ext : getExtensions()) {
+ ISearchMethodExtensionInfo extInfo = ext.getExtensionInfo();
+ if(extInfo.getDescription().equals(extensionDescription)){
+ return ext;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Gets the extension that matches with the given id.
+ * @param id Id of the search method.
+ * @return The extension matching the id or null if not found.
+ */
+ public ISearchMethodExtension getById(String id) {
+ for (ISearchMethodExtension ext : getExtensions()) {
+ ISearchMethodExtensionInfo extInfo = ext.getExtensionInfo();
+ if(extInfo.getId().equals(id)){
+ return ext;
+ }
+ }
+ return null;
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/services/QueryServices.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/services/QueryServices.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,42 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.services;
+
+import com.nokia.s60tools.apiquery.shared.exceptions.QueryOperationFailedException;
+import com.nokia.s60tools.apiquery.ui.views.main.MainView;
+
+public class QueryServices {
+
+ /**
+ * Enables the starting of API queries
+ * also from the other plug-ins that should
+ * not know anything about internal UI components.
+ * However, this method must be called from an UI thread, or
+ * use Display.getDefault().asyncExec(...) method
+ * and pass runnable as parameter in order to schedule
+ * query request to UI thread.
+ * @param queryType Query type.
+ * @param queryString Query string.
+ * @throws QueryOperationFailedException
+ */
+ public static void runAPIQuery(int queryType, String queryString) throws QueryOperationFailedException{
+ MainView.runAPIQueryFromExternalClass(queryType,
+ queryString, false);
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/settings/UserSettingListenerNotificator.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/settings/UserSettingListenerNotificator.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,30 @@
+/*
+* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.settings;
+
+import com.nokia.s60tools.apiquery.settings.UserSettings;
+
+public class UserSettingListenerNotificator {
+
+ /**
+ * Public interface to notify listeners that something is happend.
+ */
+ public static void notifyListeners(){
+ UserSettings.getInstance().settingsChanged();
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/ui/AbstractEntryTableViewerUiComposite.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/ui/AbstractEntryTableViewerUiComposite.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,280 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.ui;
+
+import java.util.Collection;
+
+import org.eclipse.jface.viewers.CheckStateChangedEvent;
+import org.eclipse.jface.viewers.CheckboxTableViewer;
+import org.eclipse.jface.viewers.IBaseLabelProvider;
+import org.eclipse.jface.viewers.ICheckStateListener;
+import org.eclipse.jface.viewers.IContentProvider;
+import org.eclipse.jface.viewers.IDoubleClickListener;
+import org.eclipse.jface.viewers.ISelectionChangedListener;
+import org.eclipse.jface.viewers.TableViewer;
+import org.eclipse.jface.viewers.ViewerSorter;
+import org.eclipse.swt.SWTException;
+import org.eclipse.swt.widgets.Composite;
+
+import com.nokia.s60tools.apiquery.shared.datatypes.config.AbstractEntry;
+import com.nokia.s60tools.apiquery.shared.datatypes.config.AbstractEntryStorage;
+import com.nokia.s60tools.apiquery.shared.datatypes.config.IConfigurationChangedListener;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ui.AbstractUiFractionComposite;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+/**
+ * Common abstract base class for entry table viewer UI composites.
+ */
+public abstract class AbstractEntryTableViewerUiComposite extends AbstractUiFractionComposite implements ICheckStateListener,
+ IConfigurationChangedListener{
+ /**
+ * Entry check state listener reference.
+ * @see com.nokia.s60tools.apiquery.web.searchmethod.ui.IEntryCheckStateListener
+ */
+ protected IEntryCheckStateListener entryCheckStateListener = null;
+ protected CheckboxTableViewer entriesViewer;
+
+ /**
+ * Constructor.
+ * @param parentComposite Parent composite for the created composite.
+ * @param style The used style for the composite.
+ */
+ public AbstractEntryTableViewerUiComposite(Composite parentComposite, int style) {
+ super(parentComposite, style);
+ }
+
+ /**
+ * Creates concrete entry viewer specific storage entry table viewer instance.
+ * @param parent Parent composite for the created composite.
+ * @return New CheckboxTableViewer object instance.
+ */
+ protected abstract CheckboxTableViewer createEntryTableViewer(Composite parent);
+
+ /**
+ * Gets concrete entry viewer specific storage instance.
+ * @return Concrete entry viewer specific storage instance.
+ */
+ protected abstract AbstractEntryStorage getEntryStorageInstance();
+
+ /**
+ * Gets concrete entry viewer specific viewer sorter.
+ * @return Concrete entry viewer specific viewer sorter.
+ */
+ protected abstract ViewerSorter createViewerSorter();
+
+ /**
+ * Gets concrete entry viewer specific label provider.
+ * @return Concrete entry viewer specific label provider.
+ */
+ protected abstract IBaseLabelProvider createLabelProvider();
+
+ /**
+ * Gets concrete entry viewer specific content provider.
+ * @return Concrete entry viewer specific content provider.
+ */
+ protected abstract IContentProvider createContentProvider();
+
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.apiquery.shared.searchmethod.ui.AbstractUiFractionComposite#createControls()
+ */
+ protected void createControls() {
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION, "-- createControls() --> " + getClass().getName()); //$NON-NLS-1$
+
+ // Concrete viewer instantiation is done by sub classes
+ entriesViewer = createEntryTableViewer(this);
+
+ // As well as creation of concrete providers and concrete entry storage
+ IContentProvider entryContentProvider = createContentProvider();
+ entriesViewer.setContentProvider(entryContentProvider);
+ IBaseLabelProvider labelProvider = createLabelProvider();
+ entriesViewer.setLabelProvider(labelProvider);
+ entriesViewer.setInput(entryContentProvider);
+ ViewerSorter entrySorter = createViewerSorter();
+ entriesViewer.setSorter(entrySorter);
+ // Storing entry storage instance reference.
+ AbstractEntryStorage entryConfigStorage = getEntryStorageInstance();
+ // Adding checked statuses before adding check state listener...
+ entriesViewer.setCheckedElements(entryConfigStorage.getSelectedEntries());
+ // ...and start listening for status changes.
+ entriesViewer.addCheckStateListener(this);
+ // Listening for configuration change events for enabling UI refresh
+ entryConfigStorage.addConfigurationChangeListener(this);
+ }
+
+ /**
+ * Refreshes the entry UI.
+ */
+ public void refresh() {
+ try {
+ entriesViewer.refresh();
+ // Check state might have been changed due to refresh
+ notifyEntryCheckStateListener();
+ } catch (SWTException e) {
+ // We might get time-to-time non-fatal SWTException: Widget is disposed,
+ // which can be ignored.
+ } catch (Exception e) {
+ // Stack trace is shown for other exceptions
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ * Gets entry table viewer instance.
+ * @return Entry table viewer instance.
+ */
+ public TableViewer getEntryViewer() {
+ return entriesViewer;
+ }
+
+ /**
+ * Adds check mark to all entries.
+ */
+ private void checkAll() {
+ // Removing possible earlier check status listener
+ entriesViewer.removeCheckStateListener(this);
+ entriesViewer.setAllChecked(true);
+ // and start listening for status changes again.
+ entriesViewer.addCheckStateListener(this);
+ if(entryCheckStateListener != null){
+ entryCheckStateListener.allEntriesChecked();
+ }
+ }
+
+ /**
+ * Removes check mark from all entries.
+ */
+ private void uncheckAll() {
+ // Removing possible earlier check status listener
+ entriesViewer.removeCheckStateListener(this);
+ // Clearing all previous check marks
+ entriesViewer.setAllChecked(false);
+ // and start listening for status changes again.
+ entriesViewer.addCheckStateListener(this);
+ if(entryCheckStateListener != null){
+ entryCheckStateListener.allEntriesUnchecked();
+ }
+ }
+
+ /**
+ * Adds selection listener to the table viewer.
+ */
+ public void addSelectionChangedListener(ISelectionChangedListener listener) {
+ entriesViewer.addSelectionChangedListener(listener);
+ }
+
+ /**
+ * Removes selection listener fromthe table viewer.
+ */
+ public void removeSelectionChangedListener(ISelectionChangedListener listener) {
+ entriesViewer.removeSelectionChangedListener(listener);
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.jface.viewers.ICheckStateListener#checkStateChanged(org.eclipse.jface.viewers.CheckStateChangedEvent)
+ */
+ public void checkStateChanged(CheckStateChangedEvent event) {
+ // Updating checked state information for the entry
+ AbstractEntry entry = (AbstractEntry) event.getElement();
+ entry.setSelected(event.getChecked());
+ notifyEntryCheckStateListener();
+ }
+
+ public void configurationChanged(int eventType) {
+ // Updating check state information to UI
+ if(eventType == IConfigurationChangedListener.ALL_ENTRIES_CHECKED){
+ checkAll();
+ }
+ else if(eventType == IConfigurationChangedListener.ALL_ENTRIES_UNCHECKED){
+ uncheckAll();
+ }
+ else{
+ // In other check cases UI must be refreshed...
+ refresh();
+ // ...before querying the latest information from storage
+ Collection entryColl = getEntryStorageInstance().getEntries();
+ for (AbstractEntry entry : entryColl) {
+ entriesViewer.setChecked(entry, entry.isSelected());
+ }
+ }
+
+ // Refreshing UI always when configuration has been changed.
+ refresh();
+ }
+
+ /**
+ * Sets entry check state listener.
+ * @param listener Listener to be set.
+ */
+ public void setEntryCheckStateListener(IEntryCheckStateListener listener) {
+ entryCheckStateListener = listener;
+ // Checking and notifying the current check status for possible listeners
+ notifyEntryCheckStateListener();
+ }
+
+ /**
+ * Checks current check status and notifies to listener
+ * if such is set.
+ */
+ private void notifyEntryCheckStateListener() {
+ if(entryCheckStateListener != null){
+ int checkElemCount = entriesViewer.getCheckedElements().length;
+ int elemCount = entriesViewer.getTable().getItemCount();
+ if(checkElemCount == 0){
+ entryCheckStateListener.allEntriesUnchecked();
+ }
+ else if(checkElemCount == elemCount){
+ entryCheckStateListener.allEntriesChecked();
+ }
+ else{
+ entryCheckStateListener.someEntriesChecked();
+ }
+ }
+ }
+
+ /**
+ * Adds a listener for double-clicks for the entry viewer.
+ * Call is delegated further to viewer class.
+ * @param listener a double-click listener
+ * @see org.eclipse.jface.viewers.StructuredViewer#addDoubleClickListener
+ */
+ public void addDoubleClickListener(IDoubleClickListener listener) {
+ entriesViewer.addDoubleClickListener(listener);
+ }
+
+ /**
+ * Removes the given double-click listener from this viewer.
+ * Call is delegated further to viewer class.
+ * @param listener a double-click listener
+ * @see org.eclipse.jface.viewers.StructuredViewer#removeDoubleClickListener
+ */
+ public void removeDoubleClickListener(IDoubleClickListener listener) {
+ entriesViewer.removeDoubleClickListener(listener);
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.Widget#dispose()
+ */
+ public void dispose(){
+ super.dispose();
+ AbstractEntryStorage entryConfigStorage = getEntryStorageInstance();
+ if(entryConfigStorage != null){
+ entryConfigStorage.removeConfigurationChangeListener(this);
+ }
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/ui/IEntryCheckStateListener.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/ui/IEntryCheckStateListener.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,40 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.ui;
+
+/**
+ * Notifies listeners when ever either all
+ * or none of the items are checke in the UI.
+ */
+public interface IEntryCheckStateListener {
+
+ /**
+ * All entries were checked.
+ */
+ public void allEntriesChecked();
+
+ /**
+ * All entries were unchecked.
+ */
+ public void allEntriesUnchecked();
+
+ /**
+ * Some entries has been checked.
+ */
+ public void someEntriesChecked();
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/ui/dialogs/APIQueryMessageBox.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/ui/dialogs/APIQueryMessageBox.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,132 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.ui.dialogs;
+
+import org.eclipse.swt.widgets.MessageBox;
+import org.eclipse.swt.widgets.Shell;
+
+import com.nokia.s60tools.apiquery.shared.common.ProductInfoRegistry;
+import com.nokia.s60tools.apiquery.shared.plugin.APIQueryPlugin;
+
+/**
+ * This class wraps the MessageBox in order to
+ * enhance it with product name, and run it in
+ * AppDep plugin's active shell context.
+ *
+ * @see org.eclipse.swt.widgets.MessageBox
+ */
+public class APIQueryMessageBox {
+
+ MessageBox msgBox;
+
+ /**
+ * Constructor.
+ * @param message User visible message.
+ * @param style Style bits.
+ */
+ public APIQueryMessageBox(String message, int style){
+ Shell sh = APIQueryPlugin.getCurrentlyActiveWbWindowShell();
+ msgBox = new MessageBox(sh, style);
+ msgBox.setMessage(message);
+ msgBox.setText(ProductInfoRegistry.getProductName());
+ }
+
+ /**
+ * Constructor.
+ * @param sh Parent shell for the new instance.
+ * @param message User visible message.
+ * @param style Style bits.
+ */
+ public APIQueryMessageBox(Shell sh, String message, int style){
+ msgBox = new MessageBox(sh, style);
+ msgBox.setMessage(message);
+ msgBox.setText(ProductInfoRegistry.getProductName());
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.Object#equals(java.lang.Object)
+ */
+ public boolean equals(Object arg0) {
+ return msgBox.equals(arg0);
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.MessageBox#getMessage()
+ */
+ public String getMessage() {
+ return msgBox.getMessage();
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.Dialog#getParent()
+ */
+ public Shell getParent() {
+ return msgBox.getParent();
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.Dialog#getStyle()
+ */
+ public int getStyle() {
+ return msgBox.getStyle();
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.Dialog#getText()
+ */
+ public String getText() {
+ return msgBox.getText();
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.Object#hashCode()
+ */
+ public int hashCode() {
+ return msgBox.hashCode();
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.MessageBox#setMessage(java.lang.String)
+ */
+ public void setMessage(String string) {
+ msgBox.setMessage(string);
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.Dialog#setText(java.lang.String)
+ */
+ public void setText(String string) {
+ msgBox.setText(string);
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.Object#toString()
+ */
+ public String toString() {
+ return msgBox.toString();
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.swt.widgets.MessageBox#open()
+ */
+ public int open() {
+ return msgBox.open();
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/LogUtils.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/LogUtils.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,72 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.util;
+
+import org.eclipse.swt.widgets.Display;
+
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.util.console.IConsolePrintUtility;
+
+/**
+ * Miscellaneous logging utilities to be used as tracing aid in case of error
+ * for which is otherwise hard to find information about the error in end-user environment
+ * unless properly logged also in production environment with exact error data.
+ */
+public class LogUtils {
+
+ /**
+ * Logs error message and expection's stack trace to product console if we are running code
+ * in Eclipse workbench environment. If not (i.e running JUnit tests)
+ * catching the exceptions and ignoring them.
+ *
+ * Logging done here because we loose important information because
+ * cache data load is done inside job that looses stack trace.
+ *
+ * @param errorMsg Error message to log.
+ * @param e Exception to log.
+ */
+ public static void logStackTrace(final String errorMsg, final Exception e) {
+ try {
+ if(e != null) e.printStackTrace();
+ // Scheduling log task to UI thread.
+ Display.getDefault().asyncExec(new Runnable(){
+ public void run() {
+ APIQueryConsole.getInstance().println(errorMsg, IConsolePrintUtility.MSG_ERROR);
+ if(e != null){
+ StackTraceElement[] stackTrace = e.getStackTrace();
+ APIQueryConsole.getInstance().printStackTrace(stackTrace);
+ }
+ }
+ });
+ } catch (Exception e2) {
+ // Ignoring possible errors due to not having workbench environment running.
+ }
+ }
+
+ /**
+ * Logs internal error message to tool's console and throws run-time exception.
+ * @param errMsg Error message to log and pass as message to runtime exception.
+ * @throws RuntimeException
+ */
+ static public void logInternalErrorAndThrowException(String errMsg) throws RuntimeException {
+ APIQueryConsole.getInstance().println("INTERNAL ERROR: " + errMsg ); //$NON-NLS-1$
+ throw new RuntimeException(errMsg);
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/SourceCodeParsingUtilities.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/SourceCodeParsingUtilities.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,101 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.util;
+
+/**
+ * Miscellaneous utilities for parsing source code.
+ */
+public class SourceCodeParsingUtilities {
+
+ /**
+ * Parses header name from include directive line.
+ * @param line Line to check for.
+ * @return Name of the header file if found, otherwise null.
+ */
+ public static String parseIncludeFromLine(String line) {
+ String include = null;
+ //If include is system inculde (#include )
+ //This can be really a user include, if user has been using
+ //SYSTEMINCLUDE and USERINCLUDE in "wrong" ways
+ if(hasSystemInclude(line)){
+ include = line.substring(line.indexOf("<") +1, line.indexOf(">")); //$NON-NLS-1$ //$NON-NLS-2$
+ include = removeIncludePath(include);
+
+ }
+ //If include is user inculde (#include "myapi.h")
+ //this can be really a system include, if user has been using
+ //SYSTEMINCLUDE and USERINCLUDE in "wrong" ways
+ else if(hasUserInclude(line)){
+ include=line.substring(line.indexOf("\"") +1, line.lastIndexOf("\"")); //$NON-NLS-1$ //$NON-NLS-2$
+ include = removeIncludePath(include);
+ }
+ return include;
+ }
+
+ /**
+ * Removes path from the include, if exists, and returns only header's basename.
+ * @param include Absolute header path name.
+ * @return Header's basename.
+ */
+ private static String removeIncludePath(String include) {
+ if(include.contains("\\")){ //$NON-NLS-1$
+ include = include.substring(include.lastIndexOf("\\") + 1); //$NON-NLS-1$
+ }
+ if(include.contains("/")){ //$NON-NLS-1$
+ include = include.substring(include.lastIndexOf("/") + 1); //$NON-NLS-1$
+ }
+ return include;
+ }
+
+ /**
+ * Checks if line contains include directive.
+ * @param line Line to check for.
+ * @return true if include was found.
+ */
+ private static boolean hasInclude(String line) {
+ return line.contains("#include"); //$NON-NLS-1$
+ }
+
+ /**
+ * Checks if line contains user include directive.
+ * @param line Line to check for.
+ * @return true if include was found.
+ */
+ public static boolean hasUserInclude(String line) {
+ return hasInclude(line) && line.contains("\""); //$NON-NLS-1$
+ }
+
+ /**
+ * Checks if line contains system include directive.
+ * @param line Line to check for.
+ * @return true if include was found.
+ */
+ public static boolean hasSystemInclude(String line) {
+ return hasInclude(line) && line.contains("<") && line.contains(">"); //$NON-NLS-1$ //$NON-NLS-2$
+ }
+
+ /**
+ * Checks if line contains system or user include directives.
+ * @param line Line to check for.
+ * @return true if an include was found.
+ */
+ public static boolean hasIncludes(String line) {
+ return hasUserInclude(line) || hasSystemInclude(line);
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/console/APIQueryConsole.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/console/APIQueryConsole.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,82 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.shared.util.console;
+
+import org.eclipse.jface.resource.ImageDescriptor;
+
+import com.nokia.s60tools.apiquery.shared.common.ProductInfoRegistry;
+import com.nokia.s60tools.apiquery.shared.plugin.APIQueryPlugin;
+import com.nokia.s60tools.apiquery.shared.resources.ImageKeys;
+import com.nokia.s60tools.util.console.AbstractProductSpecificConsole;
+import com.nokia.s60tools.util.console.IConsolePrintUtility;
+
+/**
+ * Singleton class that offers console printing
+ * services for the API Query product.
+ */
+public class APIQueryConsole extends AbstractProductSpecificConsole {
+
+ /**
+ * Singleton instance of the class.
+ */
+ static private APIQueryConsole instance = null;
+
+ /**
+ * Public accessor method.
+ * @return Singleton instance of the class.
+ */
+ static public APIQueryConsole getInstance(){
+ if(instance == null ){
+ instance = new APIQueryConsole();
+ }
+ return instance;
+ }
+
+ /**
+ * Private constructor forcing Singleton usage of the class.
+ */
+ private APIQueryConsole(){
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.util.console.AbstractProductSpecificConsole#getProductConsoleName()
+ */
+ protected String getProductConsoleName() {
+ return ProductInfoRegistry.getConsoleWindowName();
+ }
+
+ /* (non-Javadoc)
+ * @see com.nokia.s60tools.util.console.AbstractProductSpecificConsole#getProductConsoleImageDescriptor()
+ */
+ protected ImageDescriptor getProductConsoleImageDescriptor() {
+ return APIQueryPlugin.getImageDescriptorForKey(ImageKeys.IMG_APP_ICON);
+ }
+
+ /**
+ * Prints given stack trace element array contents to console as error message.
+ * @param stackTrace stack trace to be printed into the console
+ */
+ public void printStackTrace(StackTraceElement[] stackTrace) {
+ for (int i = 0; i < stackTrace.length; i++) {
+ StackTraceElement stackTraceElement = stackTrace[i];
+ String traceString = stackTraceElement.toString();
+ println(traceString, IConsolePrintUtility.MSG_ERROR);
+ }
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/xml/XMLDataSAXHandler.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/xml/XMLDataSAXHandler.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,263 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.util.xml;
+
+import java.util.EmptyStackException;
+import java.util.LinkedHashMap;
+import java.util.ListIterator;
+import java.util.Map;
+import java.util.Set;
+import java.util.Stack;
+import java.util.Vector;
+
+import org.xml.sax.Attributes;
+import org.xml.sax.SAXException;
+import org.xml.sax.SAXParseException;
+import org.xml.sax.helpers.DefaultHandler;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+/**
+ * SAX parser callback class that parses the XML into
+ * into XMLElementData object array. The set of elements
+ * and attributes to be parsed are specified in constructor.
+ *
+ * This class can parse elements that do not themselves contain
+ * any child elements. I.e. the elements to be parsed must be
+ * of flat XML. The parsed elements themselves can, of course,
+ * be contained by some parent element(s) that are not parsed
+ * by this handler.
+ */
+public class XMLDataSAXHandler extends DefaultHandler{
+
+ /**
+ * Set of element names we are interested in.
+ * Other elements are ignored.
+ */
+ private final Set elemNameSet;
+
+ /**
+ * Vector for storing the parsed elements.
+ */
+ private final Vector parsedElementsVector;
+
+ /**
+ * Flag is set to true when we are inside an element that is recognized.
+ */
+ private boolean isInsideAcceptedElement = false;
+
+ /**
+ * Name for the element currently under parsing.
+ */
+ private String parsedElementName = null;
+
+ /**
+ * Value for the element currently under parsing.
+ */
+ private String parsedElementValue = null;
+
+ /**
+ * Array for storing attribute data found for the element.
+ */
+ private Map parsedAttributeData = null;
+
+ /**
+ * Element -> Attribute set map containg attributes
+ * that should be checked for the element.
+ */
+ private final Map> attributeMap;
+
+ /**
+ * Parent restrictions for the elements.
+ */
+ private final Map parentElementRestrictionMap;
+
+ /**
+ * Storing elements to stack in order to resolve parent
+ * for the current element.
+ */
+ private final Stack elementStack;
+
+ /**
+ * Constructor.
+ * @param elemNameSet Set of element names that this handler
+ * will take into account.
+ * @param attributeMap Element -> Attribute set map containg attributes
+ * that should be checked for the element.
+ * @param parentElementRestrictionMap Parent element restrictions for parsing.
+ */
+ public XMLDataSAXHandler(Set elemNameSet, Map> attributeMap,
+ Map parentElementRestrictionMap){
+ this.elemNameSet = elemNameSet;
+ this.attributeMap = attributeMap;
+ this.parentElementRestrictionMap = parentElementRestrictionMap;
+ parsedElementsVector = new Vector();
+ parsedAttributeData = new LinkedHashMap();
+ elementStack = new Stack();
+ }
+
+ /* (non-Javadoc)
+ * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
+ */
+ public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
+
+
+ //Storing parent for the current element
+ String parentElement = null;
+ try {
+ parentElement = elementStack.peek();
+ } catch (EmptyStackException e) {
+ // Ignoring this exception
+ }
+ // Parent element is stored => We can add current element to stack.
+ elementStack.push(localName);
+
+ if(elemNameSet.contains(localName)){
+
+ // Checking if possible parent element
+ // restriction should be taken into account.
+ boolean parentElementCheckOk = true; // By default there is no restrictions
+ String parentRestriction = parentElementRestrictionMap.get(localName);
+ if(parentRestriction != null){
+
+ if(parentElement == null || (! parentElement.equalsIgnoreCase(parentRestriction))){
+ // Parent restriction is required, and does not match
+ parentElementCheckOk = false;
+ }
+ }
+
+ if(parentElementCheckOk){
+ // This is an element we are interested in
+ isInsideAcceptedElement = true;
+ parsedElementName = localName;
+
+ // Checking for possible attributes
+ Map attrMap = attributeMap.get(localName);
+ if(attrMap != null && attrMap.size() > 0){
+
+ Set attrSet = attrMap.keySet();
+ for (int i = 0; i < attributes.getLength(); i++) {
+ String attrName = attributes.getLocalName(i);
+ if(attrSet.contains(attrName)){
+ String attrValue = attributes.getValue(i);
+ parsedAttributeData.put(attrMap.get(attrName), attrValue);
+ }
+ }//for
+ }
+ }
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
+ */
+ public void characters(char[] ch, int start, int length) throws SAXException {
+ String characterDataString = new String(ch, start, length);
+
+ if(isInsideAcceptedElement){
+ if(parsedElementValue == null){
+ parsedElementValue = characterDataString;
+ }
+ else{
+ parsedElementValue = parsedElementValue + characterDataString;
+ }
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, java.lang.String)
+ */
+ public void endElement(String uri, String localName, String qName) throws SAXException {
+
+ elementStack.pop(); // Updating element stack
+
+ if(isInsideAcceptedElement){
+ // Adding element into parsed elements
+ if(parsedElementValue == null){
+ // If element did not contain value => using an empty string instead
+ parsedElementValue = ""; //$NON-NLS-1$
+ }
+ parsedElementsVector.add(new XMLElementData(parsedElementName,
+ parsedElementValue,
+ parsedAttributeData));
+ isInsideAcceptedElement = false;
+ parsedElementName = null;
+ parsedElementValue = null;
+ // For the next element there is competely new data object reserved
+ parsedAttributeData = new LinkedHashMap();
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.xml.sax.helpers.DefaultHandler#error(org.xml.sax.SAXParseException)
+ */
+ public void error(SAXParseException e) throws SAXException {
+ String xmlParseFailedUserMsg = Messages.getString("XMLDataSAXHandler.XML_Parse_Error_ConsoleMsg" //$NON-NLS-1$
+ + "( " + getCurrentParsePath() + ")"); //$NON-NLS-1$ //$NON-NLS-2$
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION,
+ xmlParseFailedUserMsg);
+ APIQueryConsole.getInstance().println(xmlParseFailedUserMsg + e.getMessage(), APIQueryConsole.MSG_ERROR);
+ throw new SAXException(e.getMessage());
+ }
+
+ /* (non-Javadoc)
+ * @see org.xml.sax.helpers.DefaultHandler#fatalError(org.xml.sax.SAXParseException)
+ */
+ public void fatalError(SAXParseException e) throws SAXException {
+ String xmlParseFailedUserMsg = Messages.getString("XMLDataSAXHandler.XML_Parse_FatalError_ConsoleMsg") //$NON-NLS-1$
+ + "( " + getCurrentParsePath() + ")"; //$NON-NLS-1$ //$NON-NLS-2$
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION,
+ xmlParseFailedUserMsg);
+ APIQueryConsole.getInstance().println(xmlParseFailedUserMsg + e.getMessage(), APIQueryConsole.MSG_ERROR);
+ throw new SAXException(e.getMessage());
+ }
+
+ /* (non-Javadoc)
+ * @see org.xml.sax.helpers.DefaultHandler#warning(org.xml.sax.SAXParseException)
+ */
+ public void warning(SAXParseException e) throws SAXException {
+ String xmlParseFailedUserMsg = Messages.getString("XMLDataSAXHandler.XML_Parse_Warning_ConsoleMsg" //$NON-NLS-1$
+ + "( " + getCurrentParsePath() + ")"); //$NON-NLS-1$ //$NON-NLS-2$
+ DbgUtility.println(DbgUtility.PRIORITY_OPERATION,
+ xmlParseFailedUserMsg);
+ APIQueryConsole.getInstance().println(xmlParseFailedUserMsg + e.getMessage(), APIQueryConsole.MSG_WARNING);
+ }
+
+ /**
+ * Element data that was parsed.
+ * @return Elements parsed.
+ */
+ public XMLElementData[] getParsedElements(){
+ return parsedElementsVector.toArray(new XMLElementData[0]);
+ }
+
+ /**
+ * Returns current parse path based on the information stored in the stack.
+ */
+ private String getCurrentParsePath(){
+ StringBuffer path = new StringBuffer("/"); //$NON-NLS-1$
+ for (ListIterator iter = elementStack.listIterator(); iter.hasNext();) {
+ String elemName = (String) iter.next();
+ path.append(elemName + "/"); //$NON-NLS-1$
+ }
+ return path.toString();
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/xml/XMLElementData.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/xml/XMLElementData.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,70 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.util.xml;
+
+import java.util.Map;
+
+/**
+ * Stores data for a single XML element that
+ * has simple string content and no sub elements.
+ * Only attribute data is stored.
+ */
+public class XMLElementData {
+
+ /**
+ * Content for the element.
+ */
+ private final String elementContent;
+
+ /**
+ * Name of the element.
+ */
+ private final String elementName;
+
+ /**
+ * Attribute data for the element.
+ */
+ private final Map attrData;
+
+ public XMLElementData(String elementName, String elementContent, Map attrData){
+ this.elementName = elementName;
+ this.elementContent = elementContent;
+ this.attrData = attrData;
+ }
+
+ /**
+ * @return the elementContent
+ */
+ public String getElementContent() {
+ return elementContent;
+ }
+
+ /**
+ * @return the elementName
+ */
+ public String getElementName() {
+ return elementName;
+ }
+
+ /**
+ * @return the attrData
+ */
+ public Map getAttributes() {
+ return attrData;
+ }
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/xml/XMLUtils.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/shared/util/xml/XMLUtils.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,652 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.shared.util.xml;
+
+import java.io.IOException;
+import java.io.StringReader;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Set;
+
+import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
+import com.nokia.s60tools.apiquery.shared.datatypes.APIDetailField;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIDetails;
+import com.nokia.s60tools.apiquery.shared.datatypes.APIShortDescription;
+import com.nokia.s60tools.apiquery.shared.datatypes.XMLToUIMappingRules;
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.util.debug.DbgUtility;
+
+/**
+ * XML Transformation utils for transforming XML data into
+ * object formats supported by user interface components.
+ * This class contains static utility methods of making
+ * conversion.
+ */
+public class XMLUtils {
+
+ //
+ //Public static variables to XML elements
+ //These element names is not ment to show in UI,
+ //but are element names only in XML document.
+ //
+
+
+ /**
+ * Element name in XML api
+ */
+ public static final String API_ELEMENT = "api"; //$NON-NLS-1$
+ /**
+ * Element name in XML source
+ */
+ public static final String API_ELEMENT_SOURCE_ATTRIBUTE = "source"; //$NON-NLS-1$
+ /**
+ * Element name in XML filename
+ */
+ public static final String API_ELEMENT_FILENAME = "filename";//$NON-NLS-1$
+ /**
+ * Element name in XML name
+ */
+ public static final String API_ELEMENT_NAME = "name";//$NON-NLS-1$
+ /**
+ * Element name in XML clients
+ */
+ public static final String API_ELEMENT_CLIENTS = "clients";//$NON-NLS-1$
+ /**
+ * Element name in XML client_org
+ */
+ public static final String API_ELEMENT_CLIENT_ORG = "client_org";//$NON-NLS-1$
+ /**
+ * Element name in XML note
+ */
+ public static final String API_ELEMENT_NOTE = "note";//$NON-NLS-1$
+ /**
+ * Element name in XML owner
+ */
+ public static final String API_ELEMENT_OWNER = "owner";//$NON-NLS-1$
+ /**
+ * Element name in XML base_service
+ */
+ public static final String API_ELEMENT_BASE_SERVICE = "base_service";//$NON-NLS-1$
+ /**
+ * Element name in XML partner_contacts
+ */
+ public static final String API_ELEMENT_PARTNER_CONTACTS = "partner_contacts";//$NON-NLS-1$
+ /**
+ * Element name in XML partners
+ */
+ public static final String API_ELEMENT_PARTNERS = "partners";//$NON-NLS-1$
+ /**
+ * Element name in XML extended_sdk_removed
+ */
+ public static final String API_ELEMENT_EXTENDED_SDK_REMOVED = "extended_sdk_removed";//$NON-NLS-1$
+ /**
+ * Element name in XML extended_sdk_deprecated
+ */
+ public static final String API_ELEMENT_EXTENDED_SDK_DEPRECATED = "extended_sdk_deprecated";//$NON-NLS-1$
+ /**
+ * Element name in XML extended_sdk_since
+ */
+ public static final String API_ELEMENT_EXTENDED_SDK_SINCE = "extended_sdk_since";//$NON-NLS-1$
+ /**
+ * Element name in XML for_adaptation_removed
+ */
+ public static final String API_ELEMENT_FOR_ADAPTATION_REMOVED = "for_adaptation_removed";//$NON-NLS-1$
+ /**
+ * Element name in XML for_adaptation_deprecated
+ */
+ public static final String API_ELEMENT_FOR_ADAPTATION_DEPRECATED = "for_adaptation_deprecated";//$NON-NLS-1$
+ /**
+ * Element name in XML for_adaptation_since
+ */
+ public static final String API_ELEMENT_FOR_ADAPTATION_SINCE = "for_adaptation_since";//$NON-NLS-1$
+ /**
+ * Element name in XML removed
+ */
+ public static final String API_ELEMENT_REMOVED = "removed";//$NON-NLS-1$
+ /**
+ * Element name in XML deprecated
+ */
+ public static final String API_ELEMENT_DEPRECATED = "deprecated";//$NON-NLS-1$
+ /**
+ * Element name in XML subsystem
+ */
+ public static final String API_ELEMENT_SUBSYSTEM = "subsystem";//$NON-NLS-1$
+ /**
+ * Element name in XML other
+ */
+ public static final String API_ELEMENT_OTHER = "other";//$NON-NLS-1$
+ /**
+ * Element name in XML import_lib
+ */
+ public static final String API_ELEMENT_IMPORT_LIB = "import_lib";//$NON-NLS-1$
+ /**
+ * Element name in XML dll
+ */
+ public static final String API_ELEMENT_DLL = "dll";//$NON-NLS-1$
+ /**
+ * Element name in XML specification
+ */
+ public static final String API_ELEMENT_SPECIFICATION = "specification";//$NON-NLS-1$
+ /**
+ * Element name in XML adaptation
+ */
+ public static final String API_ELEMENT_ADAPTATION = "adaptation";//$NON-NLS-1$
+ /**
+ * Element name in XML private
+ */
+ public static final String API_ELEMENT_PRIVATE = "private";//$NON-NLS-1$
+ /**
+ * Element name in XML internal
+ */
+ public static final String API_ELEMENT_INTERNAL = "internal";//$NON-NLS-1$
+ /**
+ * Element name in XML domain
+ */
+ public static final String API_ELEMENT_DOMAIN = "domain";//$NON-NLS-1$
+ /**
+ * Element name in XML sdk
+ */
+ public static final String API_ELEMENT_SDK = "sdk";//$NON-NLS-1$
+ /**
+ * Element name in XML responsible
+ */
+ public static final String API_ELEMENT_RESPONSIBLE = "responsible";//$NON-NLS-1$
+ /**
+ * Element name in XML type
+ */
+ public static final String API_ELEMENT_TYPE = "type";//$NON-NLS-1$
+ /**
+ * Element name in XML purpose
+ */
+ public static final String API_ELEMENT_PURPOSE = "purpose";//$NON-NLS-1$
+ /**
+ * Element name in XML key_name
+ */
+ public static final String API_ELEMENT_KEY_NAME = "key_name";//$NON-NLS-1$
+ /**
+ * Element name in XML value
+ */
+ public static final String API_ELEMENT_VALUE = "value";//$NON-NLS-1$
+ /**
+ * Element name in XML header
+ */
+ public static final String API_ELEMENT_HEADER = "header";//$NON-NLS-1$
+
+ //
+ //Public static variables to UI elements.
+ //These variables matches to XML element names, but is ment to show in UI.
+ //
+
+ /**
+ * XML element name ment to show in UI and used as key in object model Clients
+ */
+ public static final String DESCRIPTION_CLIENTS = "Clients";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Client Org
+ */
+ public static final String DESCRIPTION_CLIENT_ORG = "Client Org";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Note
+ */
+ public static final String DESCRIPTION_NOTE = "Note";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Owner
+ */
+ public static final String DESCRIPTION_OWNER = "Owner";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Base service
+ */
+ public static final String DESCRIPTION_BASE_SERVICE = "Base service";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Partner contacts
+ */
+ public static final String DESCRIPTION_PARTNER_CONTACTS = "Partner contacts";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Partners
+ */
+ public static final String DESCRIPTION_PARTNERS = "Partners";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Extended SDK Removed
+ */
+ public static final String DESCRIPTION_EXTENDED_SDK_REMOVED = "Extended SDK Removed";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Extended SDK Deprecated
+ */
+ public static final String DESCRIPTION_EXTENDED_SDK_DEPRECATED = "Extended SDK Deprecated";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Extended SDK Since
+ */
+ public static final String DESCRIPTION_EXTENDED_SDK_SINCE = "Extended SDK Since";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model For Adaptation Removed
+ */
+ public static final String DESCRIPTION_FOR_ADAPTATION_REMOVED = "For Adaptation Removed";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model For Adaptation Deprecated
+ */
+ public static final String DESCRIPTION_FOR_ADAPTATION_DEPRECATED = "For Adaptation Deprecated";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Other
+ */
+ public static final String DESCRIPTION_OTHER = "Other";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model LIBs
+ */
+ public static final String DESCRIPTION_LIBS = "LIBs";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model DLLs
+ */
+ public static final String DESCRIPTION_DLLS = "DLLs";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Specification
+ */
+ public static final String DESCRIPTION_SPECIFICATION = "Specification";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Adaptation
+ */
+ public static final String DESCRIPTION_ADAPTATION = "Adaptation";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Responsible
+ */
+ public static final String DESCRIPTION_RESPONSIBLE = "Responsible";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Type
+ */
+ public static final String DESCRIPTION_TYPE = "Type";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Purpose
+ */
+ public static final String DESCRIPTION_PURPOSE = "Purpose";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Key Name
+ */
+ public static final String DESCRIPTION_KEY_NAME = "Key Name";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Subsystem
+ */
+ public static final String DESCRIPTION_SUBSYSTEM = "Subsystem";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Removed
+ */
+ public static final String DESCRIPTION_REMOVED = "Removed"; //$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model For Adaptation Since
+ */
+ public static final String DESCRIPTION_FOR_ADAPTATION_SINCE = "For Adaptation Since";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Deprecated
+ */
+ public static final String DESCRIPTION_DEPRECATED = "Deprecated";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Private
+ */
+ public static final String DESCRIPTION_PRIVATE = "Private";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Internal
+ */
+ public static final String DESCRIPTION_INTERNAL = "Internal";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Domain
+ */
+ public static final String DESCRIPTION_DOMAIN = "Domain";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Sdk
+ */
+ public static final String DESCRIPTION_SDK = "Sdk";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model API Name
+ */
+ public static final String DESCRIPTION_API_NAME = "API Name";//$NON-NLS-1$
+ /**
+ * XML element name ment to show in UI and used as key in object model Headers
+ */
+ public static final String DESCRIPTION_HEADERS = "Headers";//$NON-NLS-1$
+
+ //
+ // Public service methods
+ //
+
+ /**
+ * Converts XML data to API details object.
+ * @param dataStrXML XML formatted data.
+ * @return API details object.
+ * @throws IOException
+ */
+ public static APIDetails xmlToAPIDetails(String dataStrXML) throws IOException{
+
+ XMLToUIMappingRules convRules = getAPIDetailsConversionRules();
+
+ return extractAPIDetailsData(dataStrXML, convRules);
+ }
+
+ /**
+ * Get Conversion rules to get API Details from XML.
+ * @return
+ */
+ public static XMLToUIMappingRules getAPIDetailsConversionRules() {
+ XMLToUIMappingRules convRules = new XMLToUIMappingRules();
+
+ //
+ // Defining mapping rules API details
+ //
+
+ // API name field
+ convRules.addRule(API_ELEMENT_NAME, DESCRIPTION_API_NAME); //$NON-NLS-1$ //$NON-NLS-2$
+ // Headers field
+ Map headerAttributes = new LinkedHashMap ();
+ headerAttributes.put(API_ELEMENT_FILENAME, API_ELEMENT_FILENAME); //$NON-NLS-1$ //$NON-NLS-2$
+ convRules.addRule(API_ELEMENT_HEADER, DESCRIPTION_HEADERS, headerAttributes); //$NON-NLS-1$ //$NON-NLS-2$
+ // Key field
+ Map keyNameAttributes = new LinkedHashMap ();
+ keyNameAttributes.put(API_ELEMENT_VALUE, API_ELEMENT_VALUE); //$NON-NLS-1$ //$NON-NLS-2$
+ convRules.addRule(API_ELEMENT_KEY_NAME, DESCRIPTION_KEY_NAME, keyNameAttributes); //$NON-NLS-1$ //$NON-NLS-2$
+ // Other fields
+ convRules.addRule(API_ELEMENT_PURPOSE, DESCRIPTION_PURPOSE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_TYPE, DESCRIPTION_TYPE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_RESPONSIBLE, DESCRIPTION_RESPONSIBLE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_SDK, DESCRIPTION_SDK, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_DOMAIN, DESCRIPTION_DOMAIN, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_INTERNAL, DESCRIPTION_INTERNAL, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_PRIVATE, DESCRIPTION_PRIVATE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_ADAPTATION, DESCRIPTION_ADAPTATION, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_SPECIFICATION, DESCRIPTION_SPECIFICATION, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_DLL, DESCRIPTION_DLLS, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_IMPORT_LIB, DESCRIPTION_LIBS, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_OTHER, DESCRIPTION_OTHER, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_SUBSYSTEM, DESCRIPTION_SUBSYSTEM, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_DEPRECATED, DESCRIPTION_DEPRECATED, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_REMOVED, DESCRIPTION_REMOVED, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_FOR_ADAPTATION_SINCE, DESCRIPTION_FOR_ADAPTATION_SINCE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_FOR_ADAPTATION_DEPRECATED, DESCRIPTION_FOR_ADAPTATION_DEPRECATED, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_FOR_ADAPTATION_REMOVED, DESCRIPTION_FOR_ADAPTATION_REMOVED, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_EXTENDED_SDK_SINCE, DESCRIPTION_EXTENDED_SDK_SINCE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_EXTENDED_SDK_DEPRECATED, DESCRIPTION_EXTENDED_SDK_DEPRECATED, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_EXTENDED_SDK_REMOVED, DESCRIPTION_EXTENDED_SDK_REMOVED, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_PARTNERS, DESCRIPTION_PARTNERS, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_PARTNER_CONTACTS, DESCRIPTION_PARTNER_CONTACTS, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_BASE_SERVICE, DESCRIPTION_BASE_SERVICE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$
+ convRules.addRule(API_ELEMENT_OWNER, DESCRIPTION_OWNER, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_NOTE, DESCRIPTION_NOTE, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_CLIENT_ORG, DESCRIPTION_CLIENT_ORG, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ convRules.addRule(API_ELEMENT_CLIENTS, DESCRIPTION_CLIENTS, API_ELEMENT); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ return convRules;
+ }
+
+ /**
+ * Converts XML data to API details object.
+ * @param dataStrXML XML formatted data.
+ * @param sourceDescription Description for the source shown in the UI.
+ * @return API details object.
+ * @throws IOException
+ */
+ public static Collection xmlToAPIShortDescription(String dataStrXML, String sourceDescription) throws IOException{
+ XMLToUIMappingRules convRules = new XMLToUIMappingRules();
+
+ //
+ // Defining mapping rules API summary
+ //
+
+ // API field is the only element to be parsed
+ // The element data contains API name and
+ // API_ELEMENT_SOURCE_ATTRIBUTE contains the
+ // source for accessing API details information.
+ Map apiAttributes = new LinkedHashMap ();
+ apiAttributes.put(API_ELEMENT_SOURCE_ATTRIBUTE, API_ELEMENT_SOURCE_ATTRIBUTE);
+ convRules.addRule(API_ELEMENT, "API", apiAttributes); //$NON-NLS-1$
+
+ return extractAPIShortDescriptionData(dataStrXML, convRules, sourceDescription);
+ }
+
+ /**
+ * Checks that there are no forbidden characters and replaces
+ * with valid ones if needed.
+ * @param in String to be checked.
+ * @return Returns checked and corrected string.
+ */
+ public static String replaceForbiddenCharacters(String in){
+ String out = in.replace("&","&"); //$NON-NLS-1$ //$NON-NLS-2$
+ out = out.replace("<","<"); //$NON-NLS-1$ //$NON-NLS-2$
+ out = out.replace(">",">"); //$NON-NLS-1$ //$NON-NLS-2$
+ out = out.replace("\"","""); //$NON-NLS-1$ //$NON-NLS-2$
+ out = out.replace("'","'"); //$NON-NLS-1$ //$NON-NLS-2$
+ return out;
+ }
+
+ //
+ // Internal classes
+ //
+
+
+ //
+ // Private methods for the class
+ //
+
+ /**
+ * Parses the given elements from the XML data
+ * and returns the resulting elements.
+ * @param XMLData XML data to be parser.
+ * @param elemNameSet Set of element names that this handler
+ * will take into account.
+ * @param attributeMap Element -> Attribute set map containg a set of attributes
+ * that should be checked for the element.
+ * @return XML elements found.
+ * @throws IOException
+ */
+ public static XMLElementData[] parseXML(String XMLData, Set elemNameSet,
+ Map>attributeMap) throws IOException{
+ return parseXML(XMLData, elemNameSet, attributeMap, new HashMap());
+ }
+
+ /**
+ * Parses the given elements from the XML data
+ * and returns the resulting elements.
+ * @param XMLData XML data to be parser.
+ * @param elemNameSet Set of element names that this handler
+ * will take into account.
+ * @param attributeMap Element -> Attribute set map containg a set of attributes
+ * that should be checked for the element.
+ * @param parentElementRestrictionMap Parent element restrictions for parsing.
+ * @return XML elements found.
+ * @throws IOException
+ */
+ public static XMLElementData[] parseXML(String XMLData, Set elemNameSet,
+ Map>attributeMap,
+ Map parentElementRestrictionMap) throws IOException{
+
+ // Creates SAX handler that takes information into generic data structure
+ XMLDataSAXHandler handler = new XMLDataSAXHandler(elemNameSet, attributeMap, parentElementRestrictionMap);
+
+ // Triggering actual XML parsing
+ try {
+ InputSource dataSource = createInputSourceFromString(XMLData);
+
+ XMLReader parser = XMLReaderFactory.createXMLReader();
+
+
+ parser.setContentHandler(handler);
+ parser.setErrorHandler(handler);
+
+ parser.parse(dataSource);
+
+ } catch (SAXException e) {
+ e.printStackTrace();
+ APIQueryConsole.getInstance().printStackTrace(e.getStackTrace());
+ throw new IOException ("XML parsing failed" + " (" + e.getMessage() + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ } catch (IOException e) {
+ e.printStackTrace();
+ APIQueryConsole.getInstance().printStackTrace(e.getStackTrace());
+ throw e;
+ }
+
+ return handler.getParsedElements();
+ }
+
+ /**
+ * Creates input source from XML data string.
+ * @param XMLData XML data string to be created input source from.
+ * @return Input source from the given string.
+ */
+ private static InputSource createInputSourceFromString(String XMLData){
+ StringReader rdr = new StringReader(XMLData);
+ return new InputSource(rdr);
+ }
+
+ /**
+ * Parsed API summary objects from given XML data string.
+ * @param XMLData XML data string to be parsed.
+ * @param mappingRules Mapping rules used to convert XML elements into
+ * corresponding descriptions.
+ * @param sourceDescription Description for the source shown in the UI.
+ * @return Collection of API summary objects extracted from the XML data.
+ * @throws IOException
+ */
+ private static Collection extractAPIShortDescriptionData(String XMLData,
+ XMLToUIMappingRules mappingRules,
+ String sourceDescription) throws IOException{
+
+ // Printing with loop-priority because there will be a lot of data printed out
+ DbgUtility.println(DbgUtility.PRIORITY_LOOP, "-*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*-"); //$NON-NLS-1$
+ DbgUtility.println(DbgUtility.PRIORITY_LOOP, "API Summary data: " + XMLData); //$NON-NLS-1$
+ DbgUtility.println(DbgUtility.PRIORITY_LOOP, "-*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*-"); //$NON-NLS-1$
+
+ ArrayList summaryList = new ArrayList();
+
+ XMLElementData[] elementArr = parseXML(XMLData,
+ mappingRules.getMapFromKeySet(),
+ mappingRules.getAttributeMap());
+
+ // Mapping data fields into corresponding API summary fields
+ for (int i = 0; i < elementArr.length; i++) {
+ // Validating first that we have data that we should have
+ if(! elementArr[i].getElementName().equals(API_ELEMENT)){
+ throw new RuntimeException("Internal error (XMLUtils): Invalid XML, expected '" + API_ELEMENT + "' element, but encountered: " + elementArr[i].getElementName()); //$NON-NLS-1$ //$NON-NLS-2$
+ }
+ if(elementArr[i].getAttributes().size() != 1){
+ throw new RuntimeException("Internal error (XMLUtils): Invalid XML, '" + API_ELEMENT + "' should be always attached with '" + API_ELEMENT_SOURCE_ATTRIBUTE + "' attribute"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ }
+
+ // Converting values into API summary
+ String source = elementArr[i].getAttributes().get(API_ELEMENT_SOURCE_ATTRIBUTE);
+ String value = elementArr[i].getElementContent(); // API name
+ summaryList.add(new APIShortDescription(value, source, sourceDescription));
+ }
+
+ return summaryList;
+ }
+
+ /**
+ * Parsed API details object from given XML data string.
+ * @param XMLData XML data string to be parsed.
+ * @param mappingRules Mapping rules used to convert XML elements into
+ * corresponding descriptions.
+ * @return API details object extracted from the XML data.
+ * @throws IOException
+ */
+ public static APIDetails extractAPIDetailsData(String XMLData,
+ XMLToUIMappingRules mappingRules) throws IOException{
+
+ // Printing with loop-priority because there will be a lot of data printed out
+ DbgUtility.println(DbgUtility.PRIORITY_LOOP, "-*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*-"); //$NON-NLS-1$
+ DbgUtility.println(DbgUtility.PRIORITY_LOOP, "API Details data: " + XMLData); //$NON-NLS-1$
+ DbgUtility.println(DbgUtility.PRIORITY_LOOP, "-*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*--*-"); //$NON-NLS-1$
+
+ APIDetails details = new APIDetails();
+
+ XMLElementData[] elementArr = parseXML(XMLData,
+ mappingRules.getMapFromKeySet(),
+ mappingRules.getAttributeMap(),
+ mappingRules.getParentElementRestrictionMap());
+
+ // Mapping data fields into corresponding API detail fields
+ for (int i = 0; i < elementArr.length; i++) {
+ XMLElementData data = elementArr[i];
+ String description = mappingRules.mapFrom(data.getElementName());
+ String value = ""; //$NON-NLS-1$
+ Map attrData = data.getAttributes();
+ boolean wasNamedParameters = false;
+
+ //If there is some attributes...
+ if(attrData.size()> 0){
+ Map attrNames = mappingRules.getAttributeNamesMap(data.getElementName());
+
+ Set keys = attrData.keySet();
+
+ // Attribute data overrides element data
+ // Attributes are used for , and elements.
+ boolean first = true;
+
+ for (String key : keys) {
+ String attr = attrData.get(key);
+ String attrKey = getKeyByValue(key, attrNames);
+
+ //set parameter description if has one!
+ if(attrNames != null && attrNames.containsValue(key) && !key.equals(attrKey)){
+ details.addOrUpdateField(key, attr);
+ wasNamedParameters = true;
+ }
+ //Comma separated values -->
+ else if(first){
+ value = attr;
+ first = false;
+ }else{
+ value = value + APIDetailField.VALUE_FIELD_SEPARATOR + attr;
+ }
+ }
+
+ }
+ else{
+ value = data.getElementContent();
+ }
+ //If there was only attributes set as own rows, must be checked that if there was some other content as well
+ // Either addig or updating an existing field.
+ //If there was named parameters, and there was no non-named parameters, then element it self is
+ //not ment to occur in UI, only independent parameters.
+ if(!wasNamedParameters || value.trim().length() > 0){
+ details.addOrUpdateField(description, value);
+ }
+ }
+
+ return details;
+ }
+
+ /**
+ * Get XML element name by UI element name.
+ * @param value
+ * @param attrNames
+ * @return
+ */
+ private static String getKeyByValue(String value,
+ Map attrNames) {
+ Set keys = attrNames.keySet();
+ for (String key : keys) {
+ String value_ = attrNames.get(key);
+ if(value_.equals(value)){
+ return key;
+ }
+ }
+ return null;
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/ui/actions/AbstractMainViewAction.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/ui/actions/AbstractMainViewAction.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,52 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.ui.actions;
+
+import org.eclipse.jface.action.Action;
+
+import com.nokia.s60tools.apiquery.ui.views.main.MainView;
+
+/**
+ * Common abstract base class for all main view
+ * related actions.
+ */
+public abstract class AbstractMainViewAction extends Action {
+
+ /**
+ * Reference to the view.
+ */
+ MainView view;
+
+ /**
+ * Constructor.
+ * @param view Reference to the view.
+ */
+ public AbstractMainViewAction(MainView view) {
+ super();
+ this.view = view;
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.jface.action.IAction#run()
+ */
+ public void run() {
+ view.updateActionButtonStates();
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/ui/actions/ToolsMenuAction.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/ui/actions/ToolsMenuAction.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,95 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+
+package com.nokia.s60tools.apiquery.ui.actions;
+
+import org.eclipse.jface.action.IAction;
+import org.eclipse.jface.viewers.ISelection;
+import org.eclipse.ui.IViewPart;
+import org.eclipse.ui.IViewReference;
+import org.eclipse.ui.IWorkbenchPage;
+import org.eclipse.ui.IWorkbenchWindow;
+import org.eclipse.ui.IWorkbenchWindowActionDelegate;
+
+import com.nokia.s60tools.apiquery.shared.util.console.APIQueryConsole;
+import com.nokia.s60tools.apiquery.ui.views.main.MainView;
+import com.nokia.s60tools.util.console.IConsolePrintUtility;
+
+public class ToolsMenuAction implements IWorkbenchWindowActionDelegate {
+
+ /**
+ * Reference to workbench window
+ */
+ private IWorkbenchWindow window;
+
+ /**
+ * Constructor.
+ */
+ public ToolsMenuAction(){
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IWorkbenchWindowActionDelegate#dispose()
+ */
+ public void dispose() {
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IWorkbenchWindowActionDelegate#init(org.eclipse.ui.IWorkbenchWindow)
+ */
+ public void init(IWorkbenchWindow window) {
+ this.window = window;
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IActionDelegate#run(org.eclipse.jface.action.IAction)
+ */
+ public void run(IAction action) {
+ try {
+ IWorkbenchPage page = window.getActivePage();
+
+ // Checking if view is already open
+ IViewReference[] viewRefs = page.getViewReferences();
+ for (int i = 0; i < viewRefs.length; i++) {
+ IViewReference reference = viewRefs[i];
+ String id = reference.getId();
+ if(id.equalsIgnoreCase(MainView.ID)){
+ // Found, restoring the view
+ IViewPart viewPart = reference.getView(true);
+ page.activate(viewPart);
+ return;
+ }
+ }
+
+ // View was not found, opening it up as a new view.
+ page.showView(MainView.ID);
+
+ } catch (Exception e) {
+ e.printStackTrace();
+ APIQueryConsole.getInstance().println(e.getMessage(),
+ IConsolePrintUtility.MSG_ERROR);
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IActionDelegate#selectionChanged(org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelection)
+ */
+ public void selectionChanged(IAction action, ISelection selection) {
+ }
+
+}
diff -r 000000000000 -r a02c979e8dfd srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/ui/dialogs/FirstTimePopUpDialog.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/srcanaapps/apiquerytool/com.nokia.s60tools.apiquery/src/com/nokia/s60tools/apiquery/ui/dialogs/FirstTimePopUpDialog.java Sat Jan 09 10:04:11 2010 +0530
@@ -0,0 +1,169 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+
+package com.nokia.s60tools.apiquery.ui.dialogs;
+
+import java.util.Collection;
+import java.util.Iterator;
+
+import org.eclipse.jface.dialogs.MessageDialog;
+import org.eclipse.swt.widgets.Shell;
+
+import com.nokia.s60tools.apiquery.shared.resources.Messages;
+import com.nokia.s60tools.apiquery.shared.searchmethod.ISearchMethodExtension;
+import com.nokia.s60tools.apiquery.shared.searchmethodregistry.SearchMethodExtensionRegistry;
+
+/**
+ * Class for showing First time pop up dialog (Quick help).
+ *
+ * This dialog is ment to open when API Query application
+ * is started for the wery first time.
+ *
+ */
+public class FirstTimePopUpDialog {
+
+ private static final String NEW_LINE = "\n\n"; //$NON-NLS-1$
+
+ /**
+ * For checking if Web data source is available to build message, we need to check
+ * id Web data source was found and we cannot have dependency to data source
+ * plug-ins in main plug-in. Thats why we keep this duplicate ID here.
+ */
+ private static final String WEB_DATASOURCE_ID = "web";
+
+ /**
+ * No construction, only static method to use.
+ *
+ */
+ private FirstTimePopUpDialog(){
+ }
+
+ /**
+ * Open the first time pop up dialog (quick help).
+ *
+ */
+ public static void open(Shell parent) {
+
+ StringBuffer msg = new StringBuffer();
+
+ msg.append(Messages.getString("FirstTimePopUpDialog.Topic_Msg")); //$NON-NLS-1$
+ msg.append(NEW_LINE);
+ msg.append(Messages.getString("FirstTimePopUpDialog.Tool_Is_For_Msg")); //$NON-NLS-1$
+
+ String dataSourcesMsg = getDataSourcesMsg();
+
+ msg.append(NEW_LINE);
+ msg.append(dataSourcesMsg);
+ msg.append(NEW_LINE);
+ msg.append(Messages.getString("FirstTimePopUpDialog.Seach_Msg")); //$NON-NLS-1$
+ msg.append(NEW_LINE);
+ msg.append(Messages.getString("FirstTimePopUpDialog.Results_Msg")); //$NON-NLS-1$
+ msg.append(NEW_LINE);
+ msg.append(Messages.getString("FirstTimePopUpDialog.Project_Query_Msg")); //$NON-NLS-1$
+ msg.append(NEW_LINE);
+ msg.append(Messages.getString("FirstTimePopUpDialog.More_Information_Msg")); //$NON-NLS-1$
+
+ MessageDialog.openInformation(parent,
+ Messages.getString("FirstTimePopUpDialog.Title_Msg"),msg.toString());//$NON-NLS-1$
+ }
+
+ /**
+ * Get part of the dialog messages where data sources are described.
+ * Message content depends on current data source configuration
+ * @return msg to show in UI
+ */
+ private static String getDataSourcesMsg() {
+
+ //Message with 3 data sources will be:
+ //To configure Data Sources, open the Properties tab at the bottom of the API Query view.
+ //Three types of Data Sources are currently available:
+ //Web Server, API Metadata files from the SDK and Excel Interface Sheets.
+ //There are three Web servers configured by default, but only two of them are enabled.
+
+ SearchMethodExtensionRegistry smeRegistry = SearchMethodExtensionRegistry.getInstance();
+ int extensionCount = smeRegistry.getExtensionCount();
+ //If we have web data source or not
+ boolean isWeb = false;
+
+ Collection extensions = smeRegistry.getExtensions();
+ String dataSourcesMsg = Messages.getString("FirstTimePopUpDialog.Properties_Msg_Configure"); //$NON-NLS-1$
+ dataSourcesMsg += " ";//$NON-NLS-1$
+ //If we have only one data source
+ if(extensionCount == 1){
+ dataSourcesMsg =Messages.getString("FirstTimePopUpDialog.Properties_Msg_Option_One_DataSources"); //$NON-NLS-1$
+ String ds1 = null;
+ for (Iterator iterator = extensions.iterator(); iterator.hasNext();) {
+ ISearchMethodExtension extension = (ISearchMethodExtension) iterator.next();
+ isWeb = isExtensionWeb(isWeb, extension);
+ ds1 = extension.getExtensionInfo().getDescription();
+ }
+ dataSourcesMsg = String.format(dataSourcesMsg, ds1);
+
+ }
+ //If we have 2 data sources available
+ else if(extensionCount == 2){
+ dataSourcesMsg = Messages.getString("FirstTimePopUpDialog.Properties_Msg_Option_Two_DataSources"); //$NON-NLS-1$
+ String ds1 = null;
+ String ds2 = null;
+ for (Iterator
+
+
+
+