blob: dbf7011137996ed811b0a416a17673b777d4cef0 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE api-answers PUBLIC "-//NetBeans//DTD Arch Answers//EN" "../nbbuild/antsrc/org/netbeans/nbbuild/Arch.dtd" [
<!ENTITY api-questions SYSTEM "../nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">
]>
<api-answers
question-version="1.28"
author="mentlicher@netbeans.org"
>
&api-questions;
<!--
<question id="arch-what">
What is this project good for?
<hint>
Please provide here a few lines describing the project,
what problem it should solve, provide links to documentation,
specifications, etc.
</hint>
</question>
-->
<answer id="arch-what">
The diff module provides the ability to visualize differences between source files.
It also has a graphical conflicts resolver tool and built-in patch algorithm.
<p>List of the main features:</p>
<ul>
<li>Simple APIs, that provide access to registered diff and merge engines and visualizers.</li>
<li>Built in and external diff engines defined.</li>
<li>Graphical diff vizualizer and conflicts resolver.</li>
<li>Extensible with additional diff and merge engines and vizualizers.</li>
<li>Patch algorithm implemented for UNIX-style, unidiff and contextual diff formats.</li>
</ul>
</answer>
<!--
<question id="compat-i18n">
Is your module correctly internationalized?
<hint>
Correct internationalization means that it obeys instuctions
at <a href="http://www.netbeans.org/devhome/docs/i18n/index.html">
NetBeans I18N pages</a>.
</hint>
</question>
-->
<answer id="compat-i18n">
Yes.
</answer>
<!--
<question id="compat-standards">
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</question>
-->
<answer id="compat-standards">
The external diff engine expect the standard UNIX-style output of the external
diff executable.
The patching algorithm supports three diff formats:
<ul>
<li>Standard UNIX-style diff format,</li>
<li>Unidiff format,</li>
<li>Contextual diff format.</li>
</ul>
</answer>
<!--
<question id="compat-version">
Can your module coexist with earlier and future
versions of itself? Can you correctly read all old settings? Will future
versions be able to read your current settings? Can you read
or politely ignore settings stored by a future version?
<hint>
Very helpful for reading settings is to store version number
there, so future versions can decide whether how to read/convert
the settings and older versions can ignore the new ones.
</hint>
</question>
-->
<answer id="compat-version">
Only one version of the module can be installed at a time.
The settings are shared across different versions, stored
and read by Java serialization and will be read in future as well.
</answer>
<!--
<question id="dep-jre">
Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
<hint>
It is expected that if your module runs on 1.x that it will run
on 1.x+1 if no, state that please. Also describe here cases where
you run different code on different versions of JRE and why.
</hint>
</question>
-->
<answer id="dep-jre">
Needs at least JRE 1.4.
</answer>
<!--
<question id="dep-jrejdk">
Do you require the JDK or is the JRE enough?
</question>
-->
<answer id="dep-jrejdk">
JRE is enough.
</answer>
<!--
<question id="dep-nb">
What other NetBeans projects does this one depend on?
<hint>
If you want, describe such projects as imported API using
the <code>&lt;api name=&quot;identification&quot; type=&quot;import or export&quot; category=&quot;stable&quot; url=&quot;where is the description&quot; /&gt;</code>
</hint>
</question>
-->
<answer id="dep-nb">
<defaultanswer generate="none"/> <!-- XXX #98880: broken -->
Several.
</answer>
<!--
<question id="dep-non-nb">
What other projects outside NetBeans does this one depend on?
<hint>
Some non-NetBeans projects are packaged as NetBeans modules
(see <a href="http://libs.netbeans.org/">libraries</a>) and
it is prefered to use this approach when more modules may
depend on such third-party library.
</hint>
</question>
-->
<answer id="dep-non-nb">
None.
</answer>
<!--
<question id="dep-platform">
On which platforms does your module run? Does it run in the same
way on each?
<hint>
If your module is using JNI or deals with special differences of
OSes like filesystems, etc. please describe here what they are.
</hint>
</question>
-->
<answer id="dep-platform">
The module is 100% pure Java and runs on any platform.
</answer>
<!--
<question id="deploy-jar">
Do you deploy just module JAR file(s) or other files as well?
<hint>
If your module consists of just one module JAR file, just confirm that.
If it uses more than one JAR, describe where they are located, how
they refer to each other.
If it consist of module JAR(s) and other files, please describe
what is their purpose, why other files are necessary. Please
make sure that installation/deinstallation leaves the system
in state as it was before installation.
</hint>
</question>
-->
<answer id="deploy-jar">
<ul>
<li>diff.jar - standard module jar file</li>
</ul>
</answer>
<!--
<question id="deploy-nbm">
Can you deploy an NBM via the Update Center?
<hint>
If not why?
</hint>
</question>
-->
<answer id="deploy-nbm">
Yes.
</answer>
<!--
<question id="deploy-packages">
Are packages of your module made inaccessible by not declaring them
public?
<hint>
NetBeans module system allows restriction of access rights to
public classes of your module from other modules. This prevents
unwanted dependencies of others on your code and should be used
whenever possible (<a href="http://www.netbeans.org/download/apis/org/openide/doc-files/upgrade.html#3.4-public-packages">
public packages
</a>).
</hint>
</question>
-->
<answer id="deploy-packages">
All public packages are accessible, no restriction applied. Diff module contains <api group="java" name="DiffAPI" type="export" category="official"/>.
Some parts of VCS modules can use semi-private API <api group="java" name="DiffImplementationAPI" type="export" category="friend"/>, namely org.netbeans.modules.diff.builtin.DiffPresenter.
</answer>
<!--
<question id="deploy-shared">
Do you need to be installed in the shared location only, or in the user directory only,
or can your module be installed anywhere?
<hint>
Installation location shall not matter, if it does explain why.
Consider also whether <code>InstalledFileLocator</code> can help.
</hint>
</question>
-->
<answer id="deploy-shared">
Module can be installed anywhere.
</answer>
<!--
<question id="exec-classloader">
Does your code create its own class loader(s)?
<hint>
A bit unusual. Please explain why and what for.
</hint>
</question>
-->
<answer id="exec-classloader">
No.
</answer>
<!--
<question id="exec-component">
Is execution of your code influenced by any (string) property
of any of your components?
<hint>
Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code>
or <code>PropertyDescriptor.getValue</code>, etc. are used to influence
a behaviour of some code. This of course forms an interface that should
be documented. Also if one depends on some interface that an object
implements (<code>component instanceof Runnable</code>) that forms an
API as well.
</hint>
</question>
-->
<answer id="exec-component">
No.
</answer>
<!--
<question id="exec-introspection">
Does your module use any kind of runtime type information (<code>instanceof</code>,
work with <code>java.lang.Class</code>, etc.)?
<hint>
Check for cases when you have an object of type A and you also
expect it to (possibly) be of type B and do some special action. That
should be documented. The same applies on operations in meta-level
(Class.isInstance(...), Class.isAssignableFrom(...), etc.).
</hint>
</question>
-->
<answer id="exec-introspection">
Yes.
<ul>
<li>DiffAction needs to detect whether the provided diff component is a TopComponent or not in order to open it in an appropriate way.</li>
<li>DiffPanel and MergePanel need to check whether the supplied document is a StyledDocument or not.</li>
<li>DiffSettings needs to alter diff services when the default is changed and thus it needs to cast the service to InstanceDataObject</li>
<li>LinesComponent needs to cast the settings objects retrieved from editor's settings</li>
<li>MergeDialogComponent needs to check class types for presenting pop-up menu actions</li>
<li>PatchAction in order to disable itself on InstanceDataObjects</li>
</ul>
</answer>
<!--
<question id="exec-privateaccess">
Are you aware of any other parts of the system calling some of
your methods by reflection?
<hint>
If so, describe the &quot;contract&quot; as an API. Likely private or friend one, but
still API and consider rewrite of it.
</hint>
</question>
-->
<answer id="exec-privateaccess">
No.
</answer>
<!--
<question id="exec-process">
Do you execute an external process from your module? How do you ensure
that the result is the same on different platforms? Do you parse output?
Do you depend on result code?
<hint>
If you feed an input, parse the output please declare that as an API.
</hint>
</question>
-->
<answer id="exec-process">
Yes, for an external diff engine. The standard UNIX diff output is expected,
it's the responsibility of the user to supply the correct executable.
</answer>
<!--
<question id="exec-property">
Is execution of your code influenced by any environment or
Java system (<code>System.getProperty</code>) property?
<hint>
If there is a property that can change the behaviour of your
code, somebody will likely use it. You should describe what it does
and the stability category of this API. You may use
<pre>
&lt;property name=&quot;id&quot; category=&quot;private&quot; &gt;
description of the property, where it is used, what it influence, etc.
&lt;/property&gt;
</pre>
</hint>
</question>
-->
<answer id="exec-property">
<api type="import" group="systemproperty" name="user.dir" category="private">
Used as a default directory in the file chooser, that is used by the patch action.
</api>
</answer>
<!--
<question id="exec-reflection">
Does your code use Java Reflection to execute other code?
<hint>
This usually indicates a missing or unsufficient API in the other
part of the system. If the other side is not aware of your dependency
this contract can be easily broken.
</hint>
</question>
-->
<answer id="exec-reflection">
No.
</answer>
<!--
<question id="format-clipboard">
Which data flavors (if any) does your code read from or insert to
the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer.Transferable</code>?
<hint>
Often Node&apos;s deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
Check your code for overriding these methods.
</hint>
</question>
-->
<answer id="format-clipboard">
No clipboard communication is implemented.
</answer>
<!--
<question id="format-dnd">
Which protocols (if any) does your code understand during Drag &amp; Drop?
<hint>
Often Node&apos;s deal with clipboard by usage of <code>Node.drag, Node.getDropType</code>.
Check your code for overriding these methods. Btw. if they are not overriden, they
by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
</hint>
</question>
-->
<answer id="format-dnd">
None.
</answer>
<!--
<question id="format-types">
Which protocols and file formats (if any) does your module read or write on disk,
or transmit or receive over the network?
</question>
-->
<answer id="format-types">
Three diff formats:
<ul>
<li>Standard UNIX-style diff format,</li>
<li>Unidiff format,</li>
<li>Contextual diff format.</li>
</ul>
</answer>
<!--
<question id="lookup-lookup">
Does your module use <code>org.openide.util.Lookup</code>
to find any components to communicate with? Which ones?
<hint>
Please describe the interfaces you are searching for, where
are defined, whether you are searching for just one or more of them,
if the order is important, etc. Also clasify the stability of such
API contract.
</hint>
</question>
-->
<answer id="lookup-lookup">
Yes. Lookup is used to get all registered diff and merge engines and visualizers.
</answer>
<!--
<question id="lookup-register">
Do you register anything into lookup for other code to find?
<hint>
Do you register using layer file or using <code>META-INF/services</code>?
Who is supposed to find your component?
</hint>
</question>
-->
<answer id="lookup-register">
Yes. The module registers two diff engines, two diff visualizers and one merge
visualizer (visual conflicts resolver).
</answer>
<!--
<question id="lookup-remove">
Do you remove entries of other modules from lookup?
<hint>
Why? Of course, that is possible, but it can be dangerous. Is the module
your are masking resource from aware of what you are doing?
</hint>
</question>
-->
<answer id="lookup-remove">
No.
</answer>
<!--
<question id="perf-exit">
Does your module run any code on exit?
</question>
-->
<answer id="perf-exit">
No.
</answer>
<!--
<question id="perf-huge_dialogs">
Does your module contain any dialogs or wizards with a large number of
GUI controls such as combo boxes, lists, trees, or text areas?
</question>
-->
<answer id="perf-huge_dialogs">
No.
</answer>
<!--
<question id="perf-limit">
Are there any hardcoded or practical limits in the number or size of
elements your code can handle?
</question>
-->
<answer id="perf-limit">
No explicit limits. Technically, the available memory size is the limit...
</answer>
<!--
<question id="perf-mem">
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
</question>
-->
<answer id="perf-mem">
TBD.
</answer>
<!--
<question id="perf-menus">
Does your module use dynamically updated context menus, or
context-sensitive actions with complicated enablement logic?
</question>
-->
<answer id="perf-menus">
No. Enabling logic is simple.
</answer>
<!--
<question id="perf-progress">
Does your module execute any long-running tasks?
<hint>Typically they are tasks like connecting over
network, computing huge amount of data, compilation.
Such communication should be done asynchronously (for example
using <code>RequestProcessor</code>), definitively it should
not block AWT thread.
</hint>
</question>
-->
<answer id="perf-progress">
The diff engines and patch action run in background to prevent blocking the
AWT thread. The running time depends on the file size.
</answer>
<!--
<question id="perf-scale">
Which external criteria influence the performance of your
program (size of file in editor, number of files in menu,
in source directory, etc.) and how well your code scales?
Please include some estimates.
</question>
-->
<answer id="perf-scale">
Size of the files, that are diffing or patching.
</answer>
<!--
<question id="perf-startup">
Does your module run any code on startup?
</question>
-->
<answer id="perf-startup">
No.
</answer>
<!--
<question id="perf-wakeup">
Does any piece of your code wake up periodically and do something
even when the system is otherwise idle (no user interaction)?
</question>
-->
<answer id="perf-wakeup">
No.
</answer>
<!--
<question id="resources-file">
Does your module use <code>java.io.File</code> directly?
<hint>
NetBeans provide a logical wrapper over plain files called
<code>org.openide.filesystems.FileObject</code> that
provides uniform access to such resources and is the prefered
way that should be used. But of course there can be situations when
this is not suitable.
</hint>
</question>
-->
<answer id="resources-file">
Yes, for temporary files and for location of the patch file.
</answer>
<!--
<question id="resources-layer">
Does your module provide own layer? Does it create any files or
folders in it? What it is trying to communicate by that and with which
components?
<hint>
NetBeans allows automatic and declarative installation of resources
by module layers. Module register files into appropriate places
and other components use that information to perform their task
(build menu, toolbar, window layout, list of templates, set of
options, etc.).
</hint>
</question>
-->
<answer id="resources-layer">
Yes. The module defines the provided diff and merge engines and visualizers
so that they can be accessed by lookup. Also settings are defined there.
</answer>
<!--
<question id="resources-mask">
Does your module mask/hide/override any resources provided by other modules in
their layers?
<hint>
If you mask a file provided by another module, you probably depend
on that and do not want the other module to (for example) change
the file&apos;s name. That module shall thus make that file available as an API
of some stability category.
</hint>
</question>
-->
<answer id="resources-mask">
No.
</answer>
<!--
<question id="resources-read">
Does your module read any resources from layers? For what purpose?
<hint>
As this is some kind of intermodule dependency, it is a kind of API.
Please describe it and clasify according to
<a href="http://openide.netbeans.org/tutorial/api-design.html#categories">
common stability categories</a>.
</hint>
</question>
-->
<answer id="resources-read">
No.
</answer>
<answer id="deploy-dependencies">
Nothing.
</answer>
<!--
<question id="arch-overall" when="init">
Describe the overall architecture.
<hint>
What will be API for
<a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi" shape="rect">
clients and what support API</a>?
What parts will be pluggable?
How will plug-ins be registered? Please use <code>&lt;api type="export"/&gt;</code>
to describe your general APIs and specify their
<a href="http://openide.netbeans.org/tutorial/api-design.html#category-private" shape="rect">
stability categories</a>.
If possible please provide simple diagrams.
</hint>
</question>
-->
<answer id="arch-overall">
<p>
Support to everything related to creation and visualization of diffs.
This library allows registrations of various diff providers and visualizers
and provides programatic access to their functionality.
</p>
</answer>
<!--
<question id="arch-quality" when="init">
How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html" shape="rect">quality</a>
of your code be tested and
how are future regressions going to be prevented?
<hint>
What kind of testing do
you want to use? How much functionality, in which areas,
should be covered by the tests? How you find out that your
project was successful?
</hint>
</question>
-->
<answer id="arch-quality">
<p>
XXX no answer for arch-quality
</p>
</answer>
<!--
<question id="arch-time" when="init">
What are the time estimates of the work?
<hint>
Please express your estimates of how long the design, implementation,
stabilization are likely to last. How many people will be needed to
implement this and what is the expected milestone by which the work should be
ready?
</hint>
</question>
-->
<answer id="arch-time">
<p>
Finished in 2002.
</p>
</answer>
<!--
<question id="arch-usecases" when="init">
<hint>
Content of this answer will be displayed as part of page at
http://www.netbeans.org/download/dev/javadoc/usecases.html
You can use tags &lt;usecase name="name&gt; regular html description &lt;/usecase&gt;
and if you want to use an URL you can prefix if with @TOP@ to begin
at the root of your javadoc
</hint>
Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase" shape="rect">
use cases</a> of the new API. Who will use it under
what circumstances? What kind of code would typically need to be written
to use the module?
</question>
-->
<answer id="arch-usecases">
<usecase id="diff-action" name="Show a diff from action">
<p>
From an action or wherever you like you can call this:
</p>
<pre>
public void diff(final StreamSource local, final StreamSource remote){
SwingUtilities.invokeLater(new Runnable() {
public void run() {
try {
<a href="@TOP@/org/netbeans/api/diff/DiffView.html">DiffView</a> view = <a href="@TOP@/org/netbeans/api/diff/Diff.html">Diff</a>.getDefault().createDiff(local, remote);
showDiff(view);
} catch (IOException ex) {
Logger.getLogger(ThisClass.class.getName()).throwing(ex);
}
}
});
}
public void showDiff(final <a href="@TOP@/org/netbeans/api/diff/DiffView.html">DiffView</a> view){
SwingUtilities.invokeLater(new Runnable() {
public void run() {
//create our panel with our view
//right now I am just going to use the diff component
// instead of a panel
//create a topcomponent with our panel
DiffTopComponent tc = new DiffTopComponent(view);
tc.setName("MY_DIFF");
tc.setDisplayName("Some display name");
tc.open();
tc.requestActive();
}
});
}
</pre>
</usecase>
<usecase id="diff-component" name="Embeded into TopComponent">
<p>
Here is a top component to display it:
</p>
<pre>
public class DiffTopComponent extends <a href="@org-openide-windows@/org/openide/windows/TopComponent.html">TopComponent</a> {
    /** Creates a new instance of DiffTopComponent */
    public DiffTopComponent(Component diffPanel) {
        setLayout(new BorderLayout());
        add(diffPanel, BorderLayout.CENTER);
getAccessibleContext().setAccessibleName(
NbBundle.getMessage(DiffTopComponent.class,
"ACSN_Diff_Top_Component")); // NOI18N
       
getAccessibleContext().setAccessibleDescription(
NbBundle.getMessage(DiffTopComponent.class,
"ACSD_Diff_Top_Component")); // NOI18N
    }
   
    public DiffTopComponent(DiffView view) {
        this(view.getComponent());
    }
    public int getPersistenceType(){
        return TopComponent.PERSISTENCE_NEVER;
    }
    protected String preferredID(){
        return "DiffTopComponent";    //NOI18N
    }
    public HelpCtx getHelpCtx() {
        return new HelpCtx(getClass());
    }
}
</pre>
</usecase>
</answer>
<!--
<question id="arch-where" when="impl">
Where one can find sources for your module?
<hint>
Please provide link to the CVS web client at
http://www.netbeans.org/download/source_browse.html
or just use tag defaultanswer generate='here'
</hint>
</question>
-->
<answer id="arch-where">
<defaultanswer generate='here' />
</answer>
<!--
<question id="compat-deprecation" when="init">
How the introduction of your project influences functionality
provided by previous version of the product?
<hint>
If you are planning to deprecate/remove/change any existing APIs,
list them here accompanied with the reason explaining why you
are doing so.
</hint>
</question>
-->
<answer id="compat-deprecation">
<p>
XXX no answer for compat-deprecation
</p>
</answer>
<!--
<question id="exec-ant-tasks" when="impl">
Do you define or register any ant tasks that other can use?
<hint>
If you provide an ant task that users can use, you need to be very
careful about its syntax and behaviour, as it most likely forms an
API for end users and as there is a lot of end users, their reaction
when such API gets broken can be pretty strong.
</hint>
</question>
-->
<answer id="exec-ant-tasks">
<p>
XXX no answer for exec-ant-tasks
</p>
</answer>
<!--
<question id="exec-threading" when="init">
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
<hint>
Is your API threadsafe? Can it be accessed from any threads or
just from some dedicated ones? Any special relation to AWT and
its Event Dispatch thread? Also
if your module calls foreign APIs which have a specific threading model,
indicate how you comply with the requirements for multithreaded access
(synchronization, mutexes, etc.) applicable to those APIs.
If your module defines any APIs, or has complex internal structures
that might be used from multiple threads, declare how you protect
data against concurrent access, race conditions, deadlocks, etc.,
and whether such rules are enforced by runtime warnings, errors, assertions, etc.
Examples: a class might be non-thread-safe (like Java Collections); might
be fully thread-safe (internal locking); might require access through a mutex
(and may or may not automatically acquire that mutex on behalf of a client method);
might be able to run only in the event queue; etc.
Also describe when any events are fired: synchronously, asynchronously, etc.
Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations" shape="rect">Threading Recommendations</a> (in progress)
</hint>
</question>
-->
<answer id="exec-threading">
<p>
XXX no answer for exec-threading
</p>
</answer>
<!--
<question id="perf-spi" when="init">
How the performance of the plugged in code will be enforced?
<hint>
If you allow foreign code to be plugged into your own module, how
do you enforce that it will behave correctly and quickly and will not
negatively influence the performance of your own module?
</hint>
</question>
-->
<answer id="perf-spi">
<p>
XXX no answer for perf-spi
</p>
</answer>
<!--
<question id="security-grant" when="final">
Does your code grant additional rights to some other code?
<hint>Avoid using a class loader that adds extra
permissions to loaded code unless really necessary.
Also note that your API implementation
can also expose unneeded permissions to enemy code by
calling AccessController.doPrivileged().</hint>
</question>
-->
<answer id="security-grant">
<p>
XXX no answer for security-grant
</p>
</answer>
<!--
<question id="security-policy" when="final">
Does your functionality require modifications to the standard policy file?
<hint>Your code might pass control to third-party code not
coming from trusted domains. This could be code downloaded over the
network or code coming from libraries that are not bundled
with NetBeans. Which permissions need to be granted to which domains?</hint>
</question>
-->
<answer id="security-policy">
<p>
XXX no answer for security-policy
</p>
</answer>
</api-answers>