Attachment #43694 for bug #91718

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 91718
Collapse All | Expand All

Added Link Here

(-)indent/.cvsignore (+1 lines)
1	build




<?xml version="1.0" encoding="UTF-8"?>
<!--
The contents of this file are subject to the terms of the Common Development
and Distribution License (the License). You may not use this file except in
compliance with the License.

You can obtain a copy of the License at http://www.netbeans.org/cddl.html
or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file
and include the License file at http://www.netbeans.org/cddl.txt.
If applicable, add the following below the CDDL Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
Microsystems, Inc. All Rights Reserved.
-->
<?xml-stylesheet type="text/xml" href="../../nbbuild/javadoctools/apichanges.xsl"?>
<!DOCTYPE apichanges PUBLIC "-//NetBeans//DTD API changes list 1.0//EN" "../../nbbuild/javadoctools/apichanges.dtd">

<!--

INFO FOR PEOPLE ADDING CHANGES:

Check the DTD (apichanges.dtd) for details on the syntax. You do not
need to regenerate the HTML, as this is part of Javadoc generation; just
change the XML. Rough syntax of a change (several parts optional):

<change>
    <api name="compiler"/>
    <summary>Some brief description here, can use <b>XHTML</b></summary>
    <version major="1" minor="99"/>
    <date day="13" month="6" year="2001"/>
    <author login="jrhacker"/>
    <compatibility addition="yes"/>
    <description>
        The main description of the change here.
        Again can use full <b>XHTML</b> as needed.
    </description>
    <class package="org.openide.compiler" name="DoWhatIWantCompiler"/>
    <issue number="14309"/>
</change>

Also permitted elements: <package>, <branch>. <version> is API spec
version, recommended for all new changes. <compatibility> should say
if things were added/modified/deprecated/etc. and give all information
related to upgrading old code. List affected top-level classes and
link to issue numbers if applicable. See the DTD for more details.

Changes need not be in any particular order, they are sorted in various
ways by the stylesheet anyway.

Dates are assumed to mean "on the trunk". If you *also* make the same
change on a stabilization branch, use the <branch> tag to indicate this
and explain why the change was made on a branch in the <description>.

Please only change this file on the trunk! Rather: you can change it
on branches if you want, but these changes will be ignored; only the
trunk version of this file is important.

Deprecations do not count as incompatible, assuming that code using the
deprecated calls continues to see their documented behavior. But do
specify deprecation="yes" in <compatibility>.

This file is not a replacement for Javadoc: it is intended to list changes,
not describe the complete current behavior, for which ordinary documentation
is the proper place.

-->

<apichanges>

    <!-- First, a list of API names you may use: -->
    <apidefs>
        <apidef name="general">General</apidef>
        <!-- etc. -->
    </apidefs>

    <!-- ACTUAL CHANGES BEGIN HERE: -->

    <changes>

        <change id="created">
            <summary>editor/indent module was created.</summary>
            <version major="1" minor="0"/>
            <date day="14" month="6" year="2007"/>
            <author login="mmetelka"/>
            <compatibility binary="compatible" source="compatible" semantic="compatible"/>
            <description>
                The module was created.
            </description>
        </change>

    </changes>

    <!-- Now the surrounding HTML text and document structure: -->

    <htmlcontents>
<!-- Generated from apichanges.xml -->
    <head>
      <title>Change History of Editor Indentation API</title>
      <link rel="stylesheet" href="prose.css" type="text/css"/>
    </head>
    <body>

<p class="overviewlink"><a href="overview-summary.html">Overview</a></p>

<h1>Introduction</h1>

<p>This document lists changes made to the <a href="overview-summary.html">Editor Indent API</a>.</p>

<!-- The actual lists of changes, as summaries and details: -->
      <hr/>
      <standard-changelists module-code-name="org.netbeans.modules.editor.indent/1"/>

      <hr/><p>@FOOTER@</p>

    </body>
  </htmlcontents>

</apichanges>




<?xml version="1.0" encoding="UTF-8"?><!-- -*- sgml-indent-step: 1 -*- -->
<!--
The contents of this file are subject to the terms of the Common Development
and Distribution License (the License). You may not use this file except in
compliance with the License.

You can obtain a copy of the License at http://www.netbeans.org/cddl.html
or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file
and include the License file at http://www.netbeans.org/cddl.txt.
If applicable, add the following below the CDDL Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
Microsystems, Inc. All Rights Reserved.
-->
<!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.29"
  author="yourname@netbeans.org"
>

  &api-questions;


<!--
        <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">
                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">
            stability categories</a>.
            If possible please provide simple diagrams.
            </hint>
        </question>
-->
 <answer id="arch-overall">
  <p>
   Editor Indentation module defines 
   <api name="EditorIndentationAPI" group="java" type="export" category="official"/>
   providing indentation and reformatting services to the clients.
   <br/>
   It also contains SPI allowing the modules to register language-specific
   indenters and formatters into
   <a href="@org-netbeans-modules-editor-mimelookup@/org/netbeans/api/editor/mimelookup/MimeLookup.html">MimeLookup</a>
   through XML layers.
  </p>
 </answer>



<!--
        <question id="arch-quality" when="init">
            How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">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>
   Unit tests are provided for checking correctness of infrastructure and delegation
   from the legacy editor actions to the new API.
  </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>
   Available for NetBeans 6.0.
  </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">
            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">
<h1>
API Usecases
</h1>

<h3>
Fix indentation of a single or multiple lines of a document.
</h3>
<p>
Altghough there are formatting actions already there may be clients
wishing to explicitly fix indentation of e.g. a newly inserted code into a Swing document.
</p>
<p>
The same code is used after inserting a newline into a document.
</p>
The 
<a href="@org-netbeans-modules-editor-indent@/org/netbeans/api/editor/indent/Indent.html">Indent</a>
is an entry point for performing reindentation. The following code should be used by clients:
<pre>
Indent indent = Indent.get(doc);
indent.lock();
try {
    doc.atomicLock();
    try {
        indent.reindent(startOffset, endOffset);
    } finally {
        doc.atomicUnlock();
    }
} finally {
    indent.unlock();
}
</pre>

<h3>
Code beautification of a selected area of a document.
</h3>
<p>
Code beautification should not only fix line indentation but it may also perform
extra changes to code according to formatting rules. For example add newlines
 or additional whitespace or add/remove extra braces etc.
</p>
The 
<a href="@org-netbeans-modules-editor-indent@/org/netbeans/api/editor/indent/Reformat.html">Reformat</a>
class should be used:
<pre>
Reformat reformat = Reformat.get(doc);
reformat.lock();
try {
    doc.atomicLock();
    try {
        reformat.reformat(startOffset, endOffset);
    } finally {
        doc.atomicUnlock();
    }
} finally {
    reformat.unlock();
}
</pre>
 </answer>



<!--
        <question id="arch-what" when="init">
            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">
  <p>
   Editor indentation performs reindentation and code beautification of Swing document.
  </p>
 </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>
   The new API should coexist with existing APIs mainly
   <a href="@org-openide-text@/org/openide/text/IndentEngine.html">IndentEngine</a>
   <a href="@org-netbeans-modules-editor-lib@/org/netbeans/editor/Formatter.html">Formatter</a>
   but in the future we would like to deprecate the mentioned APIs.
  </p>
 </answer>



<!--
        <question id="compat-i18n" when="impl">
            Is your module correctly internationalized?
            <hint>
            Correct internationalization means that it obeys instructions 
            at <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/i18n-branding.html">
            NetBeans I18N pages</a>.
            </hint>
        </question>
-->
 <answer id="compat-i18n">
  <p>
   Yes.
  </p>
 </answer>



<!--
        <question id="compat-standards" when="init">
            Does the module implement or define any standards? Is the 
            implementation exact or does it deviate somehow?
        </question>
-->
 <answer id="compat-standards">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="compat-version" when="impl">
            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">
  <p>
   Yes.
  </p>
 </answer>



<!--
        <question id="dep-jre" when="final">
            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">
  <p>
   JRE 1.5.
  </p>
 </answer>



<!--
        <question id="dep-jrejdk" when="final">
            Do you require the JDK or is the JRE enough?
        </question>
-->
 <answer id="dep-jrejdk">
  <p>
   JRE is enough.
  </p>
 </answer>



<!--
        <question id="dep-nb" when="init">
            What other NetBeans projects and modules does this one depend on?
            <hint>
            Depending on other NetBeans projects influnces the ability of
            users of your work to customize their own branded version of
            NetBeans by enabling and disabling some modules. Too
            much dependencies restrict this kind of customization. If that
            is your case, then you may want to split your functionality into
            pieces of autoload, eager and regular modules which can be
            enabled independently. Usually the answer to this question
            is generated from your <code>project.xml</code> file, but
            if it is not guessed correctly, you can suppress it by
            specifying &lt;defaultanswer generate="none"/&gt; and
            write here your own. Please describe such projects as imported APIs using
            the <code>&lt;api name="identification" type="import or export" category="stable" url="where is the description" /&gt;</code>.
            By doing this information gets listed in the summary page of your
            javadoc.
            </hint>
        </question>
-->
 <answer id="dep-nb">
  <defaultanswer generate='here' />
 </answer>



<!--
        <question id="dep-non-nb" when="init">
            What other projects outside NetBeans does this one depend on?
            
            <hint>
            Depending on 3rd party libraries is always problematic,
            especially if they are not open source, as that complicates
            the licensing scheme of NetBeans. Please enumerate your
            external dependencies here, so it is correctly understood since
            the begining what are the legal implications of your project.
            Also please note that
            some non-NetBeans projects are packaged as NetBeans modules
            (see <a href="http://libs.netbeans.org/">libraries</a>) and
            it is preferred to use this approach when more modules may
            depend and share such third-party libraries.
            </hint>
        </question>
-->
 <answer id="dep-non-nb">
  <p>
   None.
  </p>
 </answer>



<!--
        <question id="dep-platform" when="init">
            On which platforms does your module run? Does it run in the same
            way on each?
            <hint>
            If you plan any dependency on OS or any usage of native code,
            please describe why you are doing so and describe how you envision
            to enforce the portability of your code.
            Please note that there is a support for <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/api.html#how-os-specific">OS conditionally
            enabled modules</a> which together with autoload/eager modules
            can allow you to enable to provide the best OS aware support
            on certain OSes while providing compatibility bridge on the not
            supported ones.
            Also please list the supported
            OSes/HW platforms and mentioned the lovest version of JDK required
            for your project to run on. Also state whether JRE is enough or
            you really need JDK.
            </hint>
        </question>
-->
 <answer id="dep-platform">
  <p>
   All platforms.
  </p>
 </answer>



<!--
        <question id="deploy-dependencies" when="final">
            What do other modules need to do to declare a dependency on this one,
            in addition to or instead of the normal module dependency declaration
            (e.g. tokens to require)?
            <hint>
                Provide a sample of the actual lines you would add to a module manifest
                to declare a dependency, for example OpenIDE-Module-Requires: some.token.
                If other modules should not depend on this module, or should just use a
                simple regular module dependency, you can just answer "nothing". If you
                intentionally expose a semistable API to clients using implementation
                dependencies, you should mention that here (but there is no need to give
                an example of usage).
            </hint>
        </question>
-->
 <answer id="deploy-dependencies">
  <p>
   Nothing.
  </p>
 </answer>



<!--
        <question id="deploy-jar" when="impl">
            Do you deploy just module JAR file(s) or other files as well?
            <hint>
            Usually a module consist of one JAR file (perhaps with Class-Path
            extensions) and also a configuration file that enables it. If you
            have any other files, use
            &lt;api group="java.io.File" name="yourname" type="export" category="friend"&gt;...&lt;/api&gt;
            to define the location, name and stability of your files (of course
            changing "yourname" and "friend" to suit your needs).
            
            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/uninstallation leaves the system 
            in state as it was before installation.
            </hint>
        </question>
-->
 <answer id="deploy-jar">
  <p>
   Jar only.
  </p>
 </answer>



<!--
        <question id="deploy-nbm" when="impl">
            Can you deploy an NBM via the Update Center?
            <hint>
            If not why?
            </hint>
        </question>
-->
 <answer id="deploy-nbm">
  <p>
   Yes.
  </p>
 </answer>



<!--
        <question id="deploy-packages" when="init">
            Are packages of your module made inaccessible by not declaring them
            public?
            
            <hint>
            By default NetBeans build harness treats all packages are private.
            If you export some of them - either as public or friend packages,
            you should have a reason. If the reason is described elsewhere
            in this document, you can ignore this question.
            </hint>
        </question>
-->
 <answer id="deploy-packages">
  <p>
   Only API and SPI packages are public.
  </p>
 </answer>



<!--
        <question id="deploy-shared" when="final">
            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">
  <p>
   Anywhere.
  </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>
   No.
  </p>
 </answer>



<!--
        <question id="exec-classloader" when="impl">
            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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="exec-component" when="impl">
            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 behavior 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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="exec-introspection" when="impl">
            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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="exec-privateaccess" when="final">
            Are you aware of any other parts of the system calling some of 
            your methods by reflection?
            <hint>
            If so, describe the "contract" as an API. Likely private or friend one, but
            still API and consider rewrite of it.
            </hint>
        </question>
-->
 <answer id="exec-privateaccess">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="exec-process" when="impl">
            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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="exec-property" when="impl">
            Is execution of your code influenced by any environment or
            Java system (<code>System.getProperty</code>) property?
            On a similar note, is there something interesting that you
            pass to <code>java.util.logging.Logger</code>? Or do you observe
            what others log?
            <hint>
            If there is a property that can change the behavior of your 
            code, somebody will likely use it. You should describe what it does 
            and the <a href="http://openide.netbeans.org/tutorial/api-design.html#life">stability category</a>
            of this API. You may use
            <pre>
                &lt;api type="export" group="property" name="id" category="private" url="http://..."&gt;
                    description of the property, where it is used, what it influence, etc.
                &lt;/api&gt;            
            </pre>
            </hint>
        </question>
-->
 <answer id="exec-property">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="exec-reflection" when="impl">
            Does your code use Java Reflection to execute other code?
            <hint>
            This usually indicates a missing or insufficient 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">
  <p>
   No.
  </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">Threading Recommendations</a> (in progress)
            </hint>
        </question>
-->
 <answer id="exec-threading">
  <p>
   Both reindentation and reformatting are executed synchronously in a thread that calls
   the API classes (typically AWT thread).
  </p>
 </answer>



<!--
        <question id="format-clipboard" when="impl">
            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'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">
  <p>
   None.
  </p>
 </answer>



<!--
        <question id="format-dnd" when="impl">
            Which protocols (if any) does your code understand during Drag &amp; Drop?
            <hint>
            Often Node'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 overridden, they
            by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
            </hint>
        </question>
-->
 <answer id="format-dnd">
  <p>
   None.
  </p>
 </answer>



<!--
        <question id="format-types" when="impl">
            Which protocols and file formats (if any) does your module read or write on disk,
            or transmit or receive over the network? Do you generate an ant build script?
            Can it be edited and modified? 
            
            <hint>
            <p>
            Files can be read and written by other programs, modules and users. If they influence
            your behaviour, make sure you either document the format or claim that it is a private
            api (using the &lt;api&gt; tag). 
            </p>
            
            <p>
            If you generate an ant build file, this is very likely going to be seen by end users and
            they will be attempted to edit it. You should be ready for that and provide here a link
            to documentation that you have for such purposes and also describe how you are going to
            understand such files during next release, when you (very likely) slightly change the 
            format.
            </p>
            </hint>
        </question>
-->
 <answer id="format-types">
  <p>
   None.
  </p>
 </answer>



<!--
        <question id="lookup-lookup" when="init">
            Does your module use <code>org.openide.util.Lookup</code>
            or any similar technology to find any components to communicate with? Which ones?
            
            <hint>
            NetBeans is build around a generic registry of services called
            lookup. It is preferable to use it for registration and discovery
            if possible. See
            <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-util/org/openide/util/lookup/doc-files/index.html">
            The Solution to Comunication Between Components
            </a>. If you do not plan to use lookup and insist usage
            of other solution, then please describe why it is not working for
            you.
            <br/>
            When filling the final version of your arch document, 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 classify the stability of such
            API contract. Use &lt;api group=&amp;lookup&amp; /&gt; tag, so
            your information gets listed in the summary page of your javadoc.
            </hint>
        </question>
-->
 <answer id="lookup-lookup">
  <p>
   It uses MimeLookup to search for registered indentation and reformatting task factories.
  </p>
 </answer>



<!--
        <question id="lookup-register" when="final">
            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">
  <p>
   The module registers <code>org.netbeans.modules.editor.lib.FormatterOverride</code>
   implementation so that it gets callback-ed from Editor Library formatter's infrastructure.
  </p>
 </answer>



<!--
        <question id="lookup-remove" when="final">
            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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="perf-exit" when="final">
            Does your module run any code on exit?
        </question>
-->
 <answer id="perf-exit">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="perf-huge_dialogs" when="final">
            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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="perf-limit" when="init">
            Are there any hard-coded or practical limits in the number or size of
            elements your code can handle?
            <hint>
                Most of algorithms have increasing memory and speed complexity
                with respect to size of data they operate on. What is the critical
                part of your project that can be seen as a bottleneck with
                respect to speed or required memory? What are the practical
                sizes of data you tested your project with? What is your estimate
                of potential size of data that would cause visible performance
                problems? Is there some kind of check to detect such situation
                and prevent "hard" crashes - for example the CloneableEditorSupport
                checks for size of a file to be opened in editor
                and if it is larger than 1Mb it shows a dialog giving the
                user the right to decide - e.g. to cancel or commit suicide.
            </hint>
        </question>
-->
 <answer id="perf-limit">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="perf-mem" when="final">
            How much memory does your component consume? Estimate
            with a relation to the number of windows, etc.
        </question>
-->
 <answer id="perf-mem">
  <p>
   No significant memory consumption. Only line indent strings are reasonably cached.
  </p>
 </answer>



<!--
        <question id="perf-menus" when="final">
            Does your module use dynamically updated context menus, or
            context-sensitive actions with complicated and slow enablement logic?
            <hint>
                If you do a lot of tricks when adding actions to regular or context menus, you can significantly
                slow down display of the menu, even when the user is not using your action. Pay attention to
                actions you add to the main menu bar, and to context menus of foreign nodes or components. If
                the action is conditionally enabled, or changes its display dynamically, you need to check the
                impact on performance. In some cases it may be more appropriate to make a simple action that is
                always enabled but does more detailed checks in a dialog if it is actually run.
            </hint>
        </question>
-->
 <answer id="perf-menus">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="perf-progress" when="final">
            Does your module execute any long-running tasks?
            
            <hint>Long running tasks should never block 
            AWT thread as it badly hurts the UI
            <a href="http://performance.netbeans.org/responsiveness/issues.html">
            responsiveness</a>.
            Tasks like connecting over
            network, computing huge amount of data, compilation
            be done asynchronously (for example
            using <code>RequestProcessor</code>), definitively it should 
            not block AWT thread.
            </hint>
        </question>
-->
 <answer id="perf-progress">
  <p>
   Reformatting or reindentation of a large block of text can be time-consuming.
   <br/>
   The API is however not tied to be called in AWT thread only so the caller may reschedule
   the processing into another thread. It should ensure that the user won't be typing
   (or otherwise modifying) the document being reformatted.
  </p>
 </answer>



<!--
        <question id="perf-scale" when="init">
            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?
            <hint>
            Please include some estimates, there are other more detailed 
            questions to answer in later phases of implementation. 
            </hint>
        </question>
-->
 <answer id="perf-scale">
  <p>
   Size of the code block being reformatted and complexity of the reformatters.
  </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>
   The plugged in code should control its complexity. The indentation infrastructure
   may provide a logger for displaying of the time spent in the reformatting
   and reindenting tasks.
  </p>
 </answer>



<!--
        <question id="perf-startup" when="final">
            Does your module run any code on startup?
        </question>
-->
 <answer id="perf-startup">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="perf-wakeup" when="final">
            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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="resources-file" when="final">
            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 preferred
            way that should be used. But of course there can be situations when
            this is not suitable.
            </hint>
        </question>
-->
 <answer id="resources-file">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="resources-layer" when="final">
            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">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="resources-mask" when="final">
            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's name. That module shall thus make that file available as an API
            of some stability category.
            </hint>
        </question>
-->
 <answer id="resources-mask">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="resources-preferences" when="final">
            Does your module uses preferences via Preferences API? Does your module use NbPreferences or
            or regular JDK Preferences ? Does it read, write or both ? 
            Does it share preferences with other modules ? If so, then why ?
            <hint>
                You may use
                    &lt;api type="export" group="preferences"
                    name="preference node name" category="private"&gt;
                    description of individual keys, where it is used, what it
                    influences, whether the module reads/write it, etc.
                    &lt;/api&gt;
                Due to XML ID restrictions, rather than /org/netbeans/modules/foo give the "name" as org.netbeans.modules.foo.
                Note that if you use NbPreferences this name will then be the same as the code name base of the module.
            </hint>
        </question>
-->
 <answer id="resources-preferences">
  <p>
   No.
  </p>
 </answer>



<!--
        <question id="resources-read" when="final">
            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 classify according to 
            <a href="http://openide.netbeans.org/tutorial/api-design.html#categories">
            common stability categories</a>.
            </hint>
        </question>
-->
 <answer id="resources-read">
  <p>
   Not directly. Only through MimeLookup.
  </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>
   No.
  </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>
   No.
  </p>
 </answer>

</api-answers>




<?xml version="1.0" encoding="UTF-8"?>
<!--
The contents of this file are subject to the terms of the Common Development
and Distribution License (the License). You may not use this file except in
compliance with the License.

You can obtain a copy of the License at http://www.netbeans.org/cddl.html
or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file
and include the License file at http://www.netbeans.org/cddl.txt.
If applicable, add the following below the CDDL Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
Microsystems, Inc. All Rights Reserved.
-->

<project name="editor/indent" default="netbeans" basedir=".">
    <import file="../../nbbuild/templates/projectized.xml"/>
</project>

Added Link Here

(-)indent/manifest.mf (+4 lines)
1	Manifest-Version: 1.0
2	OpenIDE-Module: org.netbeans.modules.editor.indent/1
3	OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/editor/indent/Bundle.properties
4	OpenIDE-Module-Layer: org/netbeans/modules/editor/indent/resources/layer.xml

Added Link Here

(-)indent/nbproject/.cvsignore (+1 lines)
1	private




# The contents of this file are subject to the terms of the Common Development
# and Distribution License (the License). You may not use this file except in
# compliance with the License.
#
# You can obtain a copy of the License at http://www.netbeans.org/cddl.html
# or http://www.netbeans.org/cddl.txt.
#
# When distributing Covered Code, include this CDDL Header Notice in each file
# and include the License file at http://www.netbeans.org/cddl.txt.
# If applicable, add the following below the CDDL Header, with the fields
# enclosed by brackets [] replaced by your own identifying information:
# "Portions Copyrighted [year] [name of copyright owner]"
#
# The Original Software is NetBeans. The Initial Developer of the Original
# Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
# Microsystems, Inc. All Rights Reserved.

javac.source=1.5
javac.compilerargs=-Xlint:unchecked
spec.version.base=1.0

javadoc.arch=${basedir}/arch.xml
javadoc.apichanges=${basedir}/apichanges.xml
javadoc.title=Editor Indentation




<?xml version="1.0" encoding="UTF-8"?>
<!--
The contents of this file are subject to the terms of the Common Development
and Distribution License (the License). You may not use this file except in
compliance with the License.

You can obtain a copy of the License at http://www.netbeans.org/cddl.html
or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file
and include the License file at http://www.netbeans.org/cddl.txt.
If applicable, add the following below the CDDL Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
Microsystems, Inc. All Rights Reserved.
-->
<project xmlns="http://www.netbeans.org/ns/project/1">
    <type>org.netbeans.modules.apisupport.project</type>
    <configuration>
        <data xmlns="http://www.netbeans.org/ns/nb-module-project/2">
            <code-name-base>org.netbeans.modules.editor.indent</code-name-base>
            <module-dependencies>
                <dependency>
                    <code-name-base>org.netbeans.modules.editor.lib</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <release-version>1</release-version>
                        <implementation-version/>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.netbeans.modules.editor.mimelookup</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <release-version>1</release-version>
                        <specification-version>1.5</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.netbeans.modules.editor.util</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <release-version>1</release-version>
                        <specification-version>1.17</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.netbeans.modules.lexer</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <release-version>2</release-version>
                        <specification-version>1.19</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.util</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>7.9</specification-version>
                    </run-dependency>
                </dependency>
            </module-dependencies>
            <test-dependencies>
                <test-type>
                    <name>unit</name>
                    <test-dependency>
                        <code-name-base>org.netbeans.modules.editor.indent</code-name-base>
                        <recursive/>
                        <compile-dependency/>
                    </test-dependency>
                    <test-dependency>
                        <code-name-base>org.netbeans.modules.editor</code-name-base>
                        <compile-dependency/>
                    </test-dependency>
                    <test-dependency>
                        <code-name-base>org.netbeans.modules.editor.lib</code-name-base>
                        <compile-dependency/>
                    </test-dependency>
                </test-type>
                <test-type>
                    <name>qa-functional</name>
                </test-type>
            </test-dependencies>
            <public-packages>
                <package>org.netbeans.api.editor.indent</package>
                <package>org.netbeans.spi.editor.indent</package>
            </public-packages>
        </data>
    </configuration>
</project>

Added Link Here

(-)indent/src/META-INF/services/org.netbeans.modules.editor.lib.FormatterOverride (+1 lines)
1	org.netbeans.modules.editor.indent.FormatterOverrideImpl




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.api.editor.indent;

import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import org.netbeans.modules.editor.indent.IndentImpl;

/**
 * Reindentation of a single or multiple lines in the document
 * means fixing of the line's indent only but does not do any other
 * code beautification.
 * <br/>
 * The following pattern should be used:
 * <pre>
 * indent.lock();
 * try {
 *     doc.atomicLock();
 *     try {
 *         indent.reindent(...);
 *     } finally {
 *         doc.atomicUnlock();
 *     }
 * } finally {
 *     indent.unlock();
 * }
 * </pre>
 *
 * @author Miloslav Metelka
 */
public final class Indent {
    
    /**
     *  Get the indentation for the given document.
     * 
     * @param doc non-null document.
     * @return non-null indentation.
     */
    public static Indent get(Document doc) {
        IndentImpl indentImpl = IndentImpl.get(doc);
        Indent indent = indentImpl.getIndent();
        if (indent == null) {
            indent = new Indent(indentImpl);
            indentImpl.setIndent(indent);
        }
        return indent;
    }
    
    private final IndentImpl impl;
    
    private Indent(IndentImpl impl) {
        this.impl = impl;
    }
    
    /**
     * Clients should call this method before acquiring of document's write lock.
     * <br/>
     * The following pattern should be used:
     * <pre>
     * indent.lock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         indent.reindent(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     indent.unlock();
     * }
     * </pre>
     */
    public void lock() {
        impl.indentLock();
    }
    
    /**
     * Clients should call this method after releasing of document's write lock.
     * <br/>
     * The following pattern should be used:
     * <pre>
     * indent.lock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         indent.reindent(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     indent.unlock();
     * }
     * </pre>
     */
    public void unlock() {
        impl.indentUnlock();
    }
    
    /**
     * Correct indentation on a single line determined by the given offset.
     * <br/>
     * Typically it is called after newline gets inserted
     * or when a line is reindented explicitly (e.g. by pressing TAB key in emacs mode).
     * <br/>
     * This method will fallback to the editor formatting infrastructure
     * in case there are no registered indent or reformat factories.
     * 
     * @param offset &gt;=0 any offset on the line to be reformatted.
     * @throws BadLocationException in case the indenter attempted to insert/remove
     *  at an invalid offset or e.g. into a guarded section.
     */
    public void reindent(int offset) throws BadLocationException {
        reindent(offset, offset);
    }

    /**
     * Correct indentation of all lines in the given offset range.
     * <br/>
     * This method will fallback to the editor formatting infrastructure
     * in case there are no registered indent or reformat factories.
     * 
     * @param startOffset &gt;=0 any offset on a first line to be reformatted.
     * @param endOffset &gt;=startOffset any offset (including end offset) 
     *   on a last line to be reformatted.
     * @throws BadLocationException in case the indenter attempted to insert/remove
     *  at an invalid offset or e.g. into a guarded section.
     */
    public void reindent(int startOffset, int endOffset) throws BadLocationException {
        impl.reindent(startOffset, endOffset);
    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.api.editor.indent;

import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.Element;
import javax.swing.text.PlainDocument;
import org.netbeans.editor.BaseDocument;
import org.netbeans.editor.BaseKit;
import org.netbeans.editor.Formatter;
import org.netbeans.editor.Settings;
import org.netbeans.editor.SettingsNames;
import org.netbeans.lib.editor.util.ArrayUtilities;
import org.netbeans.lib.editor.util.swing.DocumentUtilities;
import org.netbeans.modules.editor.indent.IndentImpl;

/**
 * Utility methods related to indentation and reformatting.
 *
 * @author Miloslav Metelka
 */
public final class IndentUtils {
    
    private static final int MAX_CACHED_INDENT = 80;
    
    private static final String[] cachedSpacesStrings = new String[MAX_CACHED_INDENT + 1];
    static {
        cachedSpacesStrings[0] = "";
    }
    
    private static final int MAX_CACHED_TAB_SIZE = 8; // Should mostly be <= 8
    
    /**
     * Cached indentation string containing tabs.
     * <br/>
     * The cache does not contain indents smaller than the particular tabSize
     * since they are only spaces contained in cachedSpacesStrings.
     */
    private static final String[][] cachedTabIndents = new String[MAX_CACHED_TAB_SIZE][];
    
    private IndentUtils() {
        // no instances
    }
    
    /**
     * Get number of spaces that form a single indentation level.
     * 
     * @return &gt;=0 size of indentation level in spaces.
     */
    public static int indentLevelSize(Document doc) {
        int indentLevel;
        if (doc instanceof BaseDocument) {
            indentLevel = ((BaseDocument)doc).getShiftWidth();
        } else {
            Object val = Settings.getValue(BaseKit.class, SettingsNames.INDENT_SHIFT_WIDTH);
            indentLevel = (val instanceof Integer) ? ((Integer)val).intValue() : tabSize(doc);
        }
        return indentLevel;
    }

    /**
     * Get number of spaces that visually substitute '\t' character.
     * 
     * @return &gt;=0 size corresponding to '\t' character in spaces.
     */
    public static int tabSize(Document doc) {
        int tabSize;
        if (doc instanceof BaseDocument) {
            tabSize = ((BaseDocument)doc).getTabSize();
        } else {
            Object val = doc.getProperty(PlainDocument.tabSizeAttribute);
            tabSize = (val instanceof Integer) ? ((Integer)val).intValue() : 8;
        }
        assert (tabSize >= 0) : "Retrieved tabSize=" + tabSize + " < 0"; // NOI18N
        return tabSize;
    }

    /**
     * Get whether the indentation strings should contain hard tabs '\t'
     * or whether they should only contain spaces.
     * 
     * @return true if the tabs should be expanded or false if not.
     */
    public static boolean isExpandTabs(Document doc) {
        if (doc instanceof BaseDocument) {
            Formatter formatter = ((BaseDocument)doc).getFormatter();
            return (formatter != null) ? formatter.expandTabs() : true;
        } else
            return true;
    }
    
    /**
     * Get start offset of a line in a document.
     * 
     * @param doc non-null document.
     * @param offset &gt;= 0 offset anywhere on the line.
     * @throws BadLocationException for invalid offset
     */
    public static int lineStartOffset(Document doc, int offset) throws BadLocationException {
        checkOffsetInDocument(doc, offset);
        Element lineRootElement = IndentImpl.lineRootElement(doc);
        return lineRootElement.getElement(lineRootElement.getElementIndex(offset)).getStartOffset();
    }

    /**
     * Get indentation of a line in a document as a number of spaces.
     * 
     * @param doc non-null document.
     * @param lineStartOffset &gt;= 0 start offset of a line in the document.
     * @throws BadLocationException for invalid offset
     */
    public static int lineIndent(Document doc, int lineStartOffset) throws BadLocationException {
        checkOffsetInDocument(doc, lineStartOffset);
        CharSequence docText = DocumentUtilities.getText(doc);
        int indent = 0;
        int tabSize = -1;
        while (lineStartOffset < docText.length()) {
            char ch;
            switch (ch = docText.charAt(lineStartOffset)) {
                case '\n':
                    return indent;

                case '\t':
                    if (tabSize == -1)
                        tabSize = tabSize(doc);
                    // Round to next tab stop
                    indent = (indent + tabSize) / tabSize * tabSize;

                default:
                    if (Character.isWhitespace(ch))
                        indent++;
                    else
                        return indent;
            }
        }
        return indent;
    }
    
    /**
     * Create (or get from cache) indentation string for the given indent.
     * <br/>
     * The indentation settings (tab-size etc. are determined based on the given
     * document).
     * 
     * @param doc document from which the indentation settings will be retrieved.
     * @param indent &gt;=0 indentation in number of spaces.
     * @return indentation string containing tabs and spaces according to the document's
     *  settings (tab-size etc.).
     */
    public static String createIndentString(Document doc, int indent) {
        if (indent < 0)
            throw new IllegalArgumentException("indent=" + indent + " < 0"); // NOI18N
        return cachedOrCreatedIndentString(indent, isExpandTabs(doc), tabSize(doc));
    }
    
    static String cachedOrCreatedIndentString(int indent, boolean expandTabs, int tabSize) {
        String indentString;
        if (expandTabs || (indent < tabSize)) {
            if (indent <= MAX_CACHED_INDENT) {
                synchronized (cachedSpacesStrings) {
                    indentString = cachedSpacesStrings[indent];
                    if (indentString == null) {
                        // Create string with MAX_CACHED_SPACES spaces first if not cached yet
                        indentString = cachedSpacesStrings[MAX_CACHED_INDENT];
                        if (indentString == null) {
                            indentString = createSpacesString(MAX_CACHED_INDENT);
                            cachedSpacesStrings[MAX_CACHED_INDENT] = indentString;
                        }
                        indentString = indentString.substring(0, indent);
                        cachedSpacesStrings[indent] = indentString;
                    }
                }
            } else {
                indentString = createSpacesString(indent);
            }

        } else { // Do not expand tabs
            if (indent <= MAX_CACHED_INDENT && tabSize <= MAX_CACHED_TAB_SIZE) {
                synchronized (cachedTabIndents) {
                    String[] tabIndents = cachedTabIndents[tabSize];
                    if (tabIndents == null) {
                        // Do not cache spaces-only strings
                        tabIndents = new String[MAX_CACHED_INDENT - tabSize];
                        cachedTabIndents[tabSize] = tabIndents;
                    }
                    indentString = tabIndents[indent - tabSize];
                    if (indentString == null) {
                        indentString = createTabIndentString(indent, tabSize);
                        tabIndents[indent - tabSize] = indentString;
                    }
                }
            } else {
                indentString = createTabIndentString(indent, tabSize);
            }
        }
        return indentString;
    }
    
    private static String createSpacesString(int spaceCount) {
        StringBuilder sb = new StringBuilder(spaceCount);
        ArrayUtilities.appendSpaces(sb, spaceCount);
        return sb.toString();
    }
    
    private static String createTabIndentString(int indent, int tabSize) {
        StringBuilder sb = new StringBuilder();
        while (indent >= tabSize) {
            sb.append('\t');
            indent -= tabSize;
        }
        ArrayUtilities.appendSpaces(sb, indent);
        return sb.toString();
    }
    
    private static void checkOffsetInDocument(Document doc, int offset) throws BadLocationException {
        if (offset < 0)
            throw new BadLocationException("offset=" + offset + " < 0", offset); // NOI18N
        if (offset > doc.getLength())
            throw new BadLocationException("offset=" + offset + " > doc.getLength()=" + doc.getLength(), offset);
    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.api.editor.indent;

import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import org.netbeans.modules.editor.indent.IndentImpl;

/**
 * Reformatting of a block of code in a document.
 * <br/>
 * The following pattern should be used:
 * <pre>
 * reformat.lock();
 * try {
 *     doc.atomicLock();
 *     try {
 *         reformat.reformat(...);
 *     } finally {
 *         doc.atomicUnlock();
 *     }
 * } finally {
 *     reformat.unlock();
 * }
 * </pre>
 *
 * @author Miloslav Metelka
 */
public final class Reformat {
    
    /**
     *  Get the reformatting for the given document.
     * 
     * @param doc non-null document.
     * @return non-null reformat object.
     */
    public static Reformat get(Document doc) {
        IndentImpl indentImpl = IndentImpl.get(doc);
        Reformat reformat = indentImpl.getReformat();
        if (reformat == null) {
            reformat = new Reformat(indentImpl);
            indentImpl.setReformat(reformat);
        }
        return reformat;
    }
    
    private final IndentImpl impl;
    
    private Reformat(IndentImpl impl) {
        this.impl = impl;
    }
    
    /**
     * Clients should call this method before acquiring of document's write lock.
     * <br/>
     * The following pattern should be used:
     * <pre>
     * reformat.lock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         reformat.reformat(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     reformat.unlock();
     * }
     * </pre>
     */
    public void lock() {
        impl.reformatLock();
    }
    
    /**
     * Clients should call this method after releasing of document's write lock.
     * <br/>
     * The following pattern should be used:
     * <pre>
     * reformat.lock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         reformat.reformat(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     reformat.unlock();
     * }
     * </pre>
     */
    public void unlock() {
        impl.reformatUnlock();
    }
    
    /**
     * Reformat a given range of code in the given document.
     * <br/>
     * It includes possible fixing of indentation and possible code beautification
     * dependent on the implementation of the reformatter.
     * 
     * <p>
     * If the reformatter implementation is not available the reindentation
     * will be performed (i.e. just the line indentation will be fixed)
     * as a closest match.
     * 
     * @param startOffset start offset of the area to be reformatted.
     * @param endOffset end offset of the area to be reformatted.
     */
    public void reformat(int startOffset, int endOffset) throws BadLocationException {
        impl.reformat(startOffset, endOffset);
    }

}




# The contents of this file are subject to the terms of the Common Development
# and Distribution License (the License). You may not use this file except in
# compliance with the License.
#
# You can obtain a copy of the License at http://www.netbeans.org/cddl.html
# or http://www.netbeans.org/cddl.txt.
#
# When distributing Covered Code, include this CDDL Header Notice in each file
# and include the License file at http://www.netbeans.org/cddl.txt.
# If applicable, add the following below the CDDL Header, with the fields
# enclosed by brackets [] replaced by your own identifying information:
# "Portions Copyrighted [year] [name of copyright owner]"
#
# The Original Software is NetBeans. The Initial Developer of the Original
# Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
# Microsystems, Inc. All Rights Reserved.

OpenIDE-Module-Name=Editor Indentation
OpenIDE-Module-Display-Category=Editing
OpenIDE-Module-Short-Description=Contains indentation APIs and SPIs.
OpenIDE-Module-Long-Description=The module includes indenation and code formatting APIs and infrastructure.





/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor.indent;

import java.io.IOException;
import java.io.Writer;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.JTextComponent;
import org.netbeans.editor.BaseDocument;
import org.netbeans.editor.Formatter;
import org.netbeans.editor.GuardedException;
import org.netbeans.editor.ext.ExtFormatter;
import org.netbeans.spi.editor.indent.Context;

/**
 * Indentation and code reformatting services for a swing text document.
 *
 * @author Miloslav Metelka
 */
public final class FormatterImpl extends ExtFormatter {
    
    private Formatter defaultFormatter;
    
    private IndentImpl indentImpl;
    
    FormatterImpl(Formatter defaultFormatter, Document doc) {
        super(defaultFormatter.getKitClass());
        this.indentImpl = IndentImpl.get(doc);
    }
    
    public int[] getReformatBlock(JTextComponent target, String typedText) {
        return (defaultFormatter instanceof ExtFormatter)
                ? ((ExtFormatter)defaultFormatter).getReformatBlock(target, typedText)
                : null;
    }
    
    public void indentLock() {
        indentImpl.indentLock();
    }
    
    public void indentUnlock() {
        indentImpl.indentUnlock();
    }
    
    public void reformatLock() {
        indentImpl.reformatLock();
    }
    
    public void reformatUnlock() {
        indentImpl.reformatUnlock();
    }

    public int indentLine(Document doc, int offset) {
        try {
            indentImpl.reindent(offset, offset);
            return offset;
        } catch (GuardedException e) {
            java.awt.Toolkit.getDefaultToolkit().beep();
        } catch (BadLocationException e) {
            throw new IllegalStateException(e);
        }
        return offset;
    }

    /** Inserts new line at given position and indents the new line with
    * spaces.
    *
    * @param doc the document to work on
    * @param offset the offset of a character on the line
    * @return new offset to place cursor to
    */
    public int indentNewLine(Document doc, int offset) {
        try {
            doc.insertString(offset, "\n", null); // NOI18N
            offset++;
            return indentLine(doc, offset);
        } catch (GuardedException e) {
            java.awt.Toolkit.getDefaultToolkit().beep();
        } catch (BadLocationException e) {
            throw new IllegalStateException(e);
        }
        return offset;
    }

    public Writer reformat(BaseDocument doc, int startOffset, int endOffset,
    boolean indentOnly) throws BadLocationException, IOException {
        // TBD delegate somehow
        return (defaultFormatter instanceof ExtFormatter)
                ? ((ExtFormatter)defaultFormatter).reformat(doc, startOffset, endOffset, indentOnly)
                : null;
    }
    
    public int reformat(BaseDocument doc, int startOffset, int endOffset)
    throws BadLocationException {
        if (doc != indentImpl.document())
            return endOffset - startOffset; // should not happen in reality
        indentImpl.reformat(startOffset, endOffset);
        Context ctx = indentImpl.reformatContext();
        return (ctx != null)
                ? ctx.endOffset() - ctx.startOffset()
                : endOffset - startOffset;
    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor.indent;

import javax.swing.text.Document;
import org.netbeans.editor.Formatter;
import org.netbeans.modules.editor.lib.FormatterOverride;

/**
 * Indentation and code reformatting services for a swing text document.
 *
 * @author Miloslav Metelka
 */
public final class FormatterOverrideImpl implements FormatterOverride {

    public Formatter getFormatter(Document doc, Formatter defaultFormatter) {
        IndentImpl indentImpl = IndentImpl.get(doc);
        if (indentImpl.hasIndentOrReformatFactories()) {
            defaultFormatter = new FormatterImpl(defaultFormatter, doc);
        }
        return defaultFormatter;
    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor.indent;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Logger;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.Element;
import javax.swing.text.StyledDocument;
import org.netbeans.api.editor.indent.Indent;
import org.netbeans.api.editor.indent.Reformat;
import org.netbeans.api.editor.mimelookup.MimeLookup;
import org.netbeans.api.editor.mimelookup.MimePath;
import org.netbeans.api.lexer.LanguagePath;
import org.netbeans.api.lexer.TokenHierarchy;
import org.netbeans.editor.BaseDocument;
import org.netbeans.spi.editor.indent.Context;
import org.netbeans.spi.editor.indent.ExtraLock;
import org.netbeans.spi.editor.indent.IndentTask;
import org.netbeans.spi.editor.indent.ReformatTask;
import org.openide.util.Lookup;

/**
 * Indentation and code reformatting services for a swing text document.
 *
 * @author Miloslav Metelka
 */
public final class IndentImpl {
    
    // -J-Dorg.netbeans.modules.editor.indent.IndentImpl=FINE
    private static final Logger LOG = Logger.getLogger(IndentImpl.class.getName());
    
    public static IndentImpl get(Document doc) {
        IndentImpl indentImpl = (IndentImpl)doc.getProperty(IndentImpl.class);
        if (indentImpl == null) {
            indentImpl = new IndentImpl(doc);
            doc.putProperty(IndentImpl.class, indentImpl);
        }
        return indentImpl;
    }
    
    private final Document doc;
    
    private Indent indent;
    
    private Reformat reformat;
    
    private TaskHandler indentHandler;
    
    private TaskHandler reformatHandler;
    
    public IndentImpl(Document doc) {
        this.doc = doc;
    }
    
    public Document document() {
        return doc;
    }
    
    public Indent getIndent() {
        return indent;
    }
    
    public void setIndent(Indent indent) {
        this.indent = indent;
    }

    public Reformat getReformat() {
        return reformat;
    }
    
    public void setReformat(Reformat reformat) {
        this.reformat = reformat;
    }
    
    public boolean hasIndentOrReformatFactories() {
        return new TaskHandler(true, doc).hasFactories();
    }
    
    public synchronized void indentLock() {
        if (indentHandler != null)
            throw new IllegalStateException("Already locked");
        indentHandler = new TaskHandler(true, doc);
        if (indentHandler.collectTasks()) {
            indentHandler.lock();
        }
    }
    
    public synchronized void indentUnlock() {
        if (indentHandler == null)
            throw new IllegalStateException("Already unlocked");
        indentHandler.unlock();
        indentHandler = null;
    }
    
    public Context indentContext() {
        return indentHandler.context();
    }
    
    public synchronized void reformatLock() {
        if (reformatHandler != null)
            throw new IllegalStateException("Already locked");
        reformatHandler = new TaskHandler(false, doc);
        if (reformatHandler.collectTasks()) {
            reformatHandler.lock();
        }
    }
    
    public synchronized void reformatUnlock() {
        if (reformatHandler == null)
            throw new IllegalStateException("Already unlocked");
        reformatHandler.unlock();
        reformatHandler = null;
    }
    
    public Context reformatContext() {
        return reformatHandler.context();
    }

    public void reindent(int startOffset, int endOffset) throws BadLocationException {
        assert (indentHandler != null) : "Not locked. Use Indent.lock()"; // NOI18N
        assert (startOffset <= endOffset) : "startOffset=" + startOffset + " > endOffset=" + endOffset; // NOI18N
        // Find begining of line
        Element lineRootElem = lineRootElement(doc);
        // Correct the start offset to point to the begining of the start line
        int startLineIndex = lineRootElem.getElementIndex(startOffset);
        if (startLineIndex < 0)
            return; // Invalid line index => do nothing
        Element lineElem = lineRootElem.getElement(startLineIndex);
        int startLineOffset = lineElem.getStartOffset();
        boolean done = false;
        if (indentHandler.hasItems()) {
            // Find ending line element - by default use the same as for start offset
            if (endOffset > lineElem.getEndOffset()) { // need to get a different line element
                int endLineIndex = lineRootElem.getElementIndex(endOffset);
                lineElem = lineRootElem.getElement(endLineIndex);
                // Check if the given endOffset ends right after line's newline (in fact at the begining of the next line)
                if (endLineIndex > 0 && lineElem.getStartOffset() == endOffset) {
                    endLineIndex--;
                    lineElem = lineRootElem.getElement(endLineIndex);
                }
            }

            // Create context from begining of the start line till the end of the end line.
            IndentSpiPackageAccessor.get().resetBounds(
                    indentHandler.context(),
                    doc.createPosition(startLineOffset),
                    doc.createPosition(lineElem.getEndOffset()));
            
            // Perform whole reindent on top and possibly embedded levels
            indentHandler.runTasks();
            done = true;
        }

        // Fallback to Formatter
        if (!done && doc instanceof BaseDocument) {
            // Original formatter does not have reindentation of multiple lines
            // so reformat start line and continue for each line.
            do {
                ((BaseDocument)doc).getFormatter().indentLine(doc, startOffset);
                startOffset = lineElem.getEndOffset(); // Move to next line
            } while (startOffset < endOffset);

        }
    }

    public void reformat(int startOffset, int endOffset) throws BadLocationException {
        assert (reformatHandler != null) : "Not locked. Use Reformat.lock()"; // NOI18N
        assert (startOffset <= endOffset) : "startOffset=" + startOffset + " > endOffset=" + endOffset; // NOI18N
        boolean done = false;
        if (reformatHandler.hasItems()) {
            IndentSpiPackageAccessor.get().resetBounds(
                    reformatHandler.context(),
                    doc.createPosition(startOffset),
                    doc.createPosition(endOffset));
            
            // Run top and embedded reformatting
            reformatHandler.runTasks();
            
            // Perform reformatting of the top section and possible embedded sections
            done = true;
        }
        
        // Fallback to Formatter
        if (!done && doc instanceof BaseDocument) {
            BaseDocument bdoc = (BaseDocument)doc;
            bdoc.getFormatter().reformat(bdoc, startOffset, endOffset);
        }
    }
    
    public static Element lineRootElement(Document doc) {
        return (doc instanceof StyledDocument)
            ? ((StyledDocument)doc).getParagraphElement(0).getParentElement()
            : doc.getDefaultRootElement();
    }

    private static final class TaskHandler {
        
        private boolean indent;
        
        private Context context;
        
        private List<MimeItem> items;
        
        private Map<MimePath,MimeItem> mime2Item;
        
        private int maxMimePathSize;
        
        TaskHandler(boolean indent, Document doc) {
            this.indent = indent;
            context = IndentSpiPackageAccessor.get().createContext(indent, doc);
        }
        
        boolean isIndent() {
            return indent;
        }
        
        Context context() {
            return context;
        }
        
        Document document() {
            return context.document();
        }
        
        int maxMimePathSize() {
            return maxMimePathSize;
        }
        
        boolean collectTasks() {
            String mimeType = docMimeType();
            if (mimeType != null) {
                // Get base indent task for the document.
                // Only if it exists also get the ones for possible embedded sections.
                MimePath mimePath = MimePath.get(mimeType);
                if (addItem(mimePath)) {
                    // Also add the embedded ones
                    TokenHierarchy<?> hi = TokenHierarchy.get(document());
                    if (hi != null) {
                        Set<LanguagePath> languagePaths = hi.languagePaths();
                        for (LanguagePath lp : languagePaths) {
                            mimePath = MimePath.parse(lp.mimePath());
                            addItem(mimePath);
                        }
                    }
                }
            }
            return (items != null);
        }

        void lock() {
            for (MimeItem item : items) {
                item.lock();
            }
        }

        void unlock() {
            for (MimeItem item : items) {
                item.unlock();
            }
        }
        
        boolean hasFactories() {
            String mimeType = docMimeType();
            return (mimeType != null && new MimeItem(this, MimePath.get(mimeType)).hasFactories());
        }
        
        boolean hasItems() {
            return (items != null);
        }
        
        void runTasks() throws BadLocationException {
            // Run top-level task and possibly embedded tasks according to the context
            if (items == null) // Do nothing for no items
                return;
            
            // Start with the doc's mime type's task
            item(0).runTask();

            // Continue by reformatting the embedded sections from top-level to embedded
            int mimePathSize = 2;
            while (mimePathSize < maxMimePathSize) {
                // TBD walk the top-level token sequence and go into it
                mimePathSize++;
            }

        }
        
        private boolean addItem(MimePath mimePath) {
            maxMimePathSize = Math.max(maxMimePathSize, mimePath.size());
            MimeItem item = new MimeItem(this, mimePath);
            if (item.createTask()) {
                if (items == null) {
                    items = new ArrayList<MimeItem>();
                    mime2Item = new HashMap<MimePath,MimeItem>();
                }
                if (!mime2Item.containsKey(item.mimePath())) {
                    items.add(item);
                    mime2Item.put(item.mimePath(), item);
                }
                return true;
            }
            return false;
        }
        
        private MimeItem item(int index) {
            return items.get(index);
        }
        
        private String docMimeType() {
            return (String)document().getProperty("mimeType");
        }
        
    }
    
    /**
     * Item that services indentation/reformatting for a single mime-path.
     */
    private static final class MimeItem {
        
        private final TaskHandler handler;
        
        private final MimePath mimePath;
        
        private IndentTask indentTask;
        
        private ReformatTask reformatTask;
        
        private ExtraLock extraLock;
        
        MimeItem(TaskHandler handler, MimePath mimePath) {
            this.handler = handler;
            this.mimePath = mimePath;
        }
        
        MimePath mimePath() {
            return mimePath;
        }
        
        boolean hasFactories() {
            Lookup lookup = MimeLookup.getLookup(mimePath);
            return (lookup.lookup(IndentTask.Factory.class) != null)
                || (lookup.lookup(ReformatTask.Factory.class) != null);
        }
        
        boolean createTask() {
            Lookup lookup = MimeLookup.getLookup(mimePath);
            if (!handler.isIndent()) { // Attempt reformat task first
                ReformatTask.Factory factory = lookup.lookup(ReformatTask.Factory.class);
                if (factory != null && (reformatTask = factory.createTask(handler.context())) != null) {
                    extraLock = reformatTask.reformatLock();
                    return true;
                }
            }
            
            if (handler.isIndent() || reformatTask == null) { // Possibly fallback to reindent for reformatting
                IndentTask.Factory factory = lookup.lookup(IndentTask.Factory.class);
                if (factory != null && (indentTask = factory.createTask(handler.context())) != null) {
                    extraLock = indentTask.indentLock();
                    return true;
                }
            }
            return false;
        }
        
        void lock() {
            extraLock.lock();
        }
        
        void runTask() throws BadLocationException {
            if (indentTask != null) {
                indentTask.reindent();
            } else {
                reformatTask.reformat();
            }
        }
        
        void unlock() {
            extraLock.unlock();
        }

    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor.indent;

import javax.swing.text.Document;
import javax.swing.text.Position;
import org.netbeans.spi.editor.indent.Context;

/**
 * Accessor for the package-private functionality of bookmarks API.
 *
 * @author Miloslav Metelka
 * @version 1.00
 */

public abstract class IndentSpiPackageAccessor {
    
    private static IndentSpiPackageAccessor INSTANCE;
    
    public static IndentSpiPackageAccessor get() {
        if (INSTANCE == null) {
            // Enforce the static initializer in Context class to be run
            try {
                Class.forName(Context.class.getName(), true, Context.class.getClassLoader());
            } catch (ClassNotFoundException e) { }
        }
        return INSTANCE;
    }

    /**
     * Register the accessor. The method can only be called once
     * - othewise it throws IllegalStateException.
     * 
     * @param accessor instance.
     */
    public static void register(IndentSpiPackageAccessor accessor) {
        if (INSTANCE != null) {
            throw new IllegalStateException("Already registered"); // NOI18N
        }
        INSTANCE = accessor;
    }
    
    public abstract Context createContext(boolean indent, Document doc);
    
    public abstract void resetBounds(Context ctx, Position startPos, Position endPos);
    
}




<?xml version="1.0" encoding="UTF-8"?>
<!--
The contents of this file are subject to the terms of the Common Development
and Distribution License (the License). You may not use this file except in
compliance with the License.

You can obtain a copy of the License at http://www.netbeans.org/cddl.html
or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file
and include the License file at http://www.netbeans.org/cddl.txt.
If applicable, add the following below the CDDL Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
Microsystems, Inc. All Rights Reserved.
-->
<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.1//EN" "http://www.netbeans.org/dtds/filesystem-1_1.dtd">


<filesystem>
    <folder name="Editors">
    </folder>
</filesystem>




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.spi.editor.indent;

import javax.swing.text.Document;
import javax.swing.text.Position;
import org.netbeans.modules.editor.indent.IndentSpiPackageAccessor;


/**
 * Context information for both indentation and reformatting.
 * <br/>
 * A common class allows to conveniently share code between indentation and reformatting.
 * {@link #isIndent()} allows to check whether the actual processing
 * is indentation or reformatting.
 *
 * @author Miloslav Metelka
 */

public final class Context {
    
    static {
        IndentSpiPackageAccessor.register(new PackageAccessor());
    }
    
    private final boolean indent;
    
    private final Document doc;
    
    private Position startPos;
    
    private Position endPos;
    
    Context(boolean indent, Document doc) {
        this.indent = indent;
        this.doc = doc;
        this.startPos = startPos;
        this.endPos = endPos;
    }
    
    /**
     * Document for which the reformatting or indenting is being done.
     */
    public Document document() {
        return doc;
    }
    
    /**
     * Starting offset of the area to be reformatted or reindented.
     * <br/>
     * The value gets updated accordingly when the reformatter performs modifications
     * in the affected area.
     */
    public int startOffset() {
        return (startPos != null) ? startPos.getOffset() : -1;
    }
    
    /**
     * Starting offset of the area to be reformatted or reindented.
     * <br/>
     * The value gets updated accordingly when the reformatter performs modifications
     * in the affected area.
     */
    public int endOffset() {
        return (endPos != null) ? endPos.getOffset() : -1;
    }
    
    /**
     * Modify indent of the line at the offset passed as the parameter.
     */
    public void modifyIndent(int offset) {
        // TBD
    }
    
    /*
     * Check whether the actual processing
     * is indentation or reformatting.
     * 
     * <br/>
     * Indent tasks may be used for reformatting in case a reformat task
     * is not available (for the given mimepath) but the indent task is available.
     * 
     * @return true if indentation is being done or false for reformatting.
     */
    public boolean isIndent() {
        return indent;
    }
    
    void resetBounds(Position startPos, Position endPos) {
        this.startPos = startPos;
        this.endPos = endPos;
    }

    private static final class PackageAccessor extends IndentSpiPackageAccessor {

        public Context createContext(boolean indent, Document doc) {
            return new Context(indent, doc);
        }
        
        public void resetBounds(Context ctx, Position startPos, Position endPos) {
            ctx.resetBounds(startPos, endPos);
        }
        
    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.spi.editor.indent;

/**
 * Extra locking may be necessary for indentation/reformatting
 * before the document gets write-locked and the actual
 * indentation/reformatting gets started.
 * <br/>
 * For example java infrastructure requires this.
 * <br/>
 * The infrastructure guarantees this processing:
 * <pre>
 *   extraLock.lock();
 *   try {
 *       doc.atomicLock(); // either BaseDocument or e.g. NbDocument.runAtomic()
 *       try {
 *           // indent or reformat ...
 *       } finally {
 *           doc.atomicUnlock();
 *       }
 *   } finally {
 *       extraLock.unlock();
 *   }
 * </pre>
 *
 * @author Miloslav Metelka
 */

public interface ExtraLock {

    void lock();
        
    void unlock();
    
}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.spi.editor.indent;

import javax.swing.text.BadLocationException;

/**
 * Indent task performs indentation on a single or multiple lines.
 * <br/>
 * Typically it is used to fix indentation after newline was inserted
 * or to fix indentation for a selected block of code.
 *
 * @author Miloslav Metelka
 */

public interface IndentTask {

    /**
     * Perform reindentation of the line(s) of {@link Context#getDocument()}
     * between {@link Context#startOffset()} and {@link Context#endOffset()}.
     * <br/>
     * It is called from AWT thread and it should process synchronously. It is used
     * after a newline is inserted after the user presses Enter
     * or when a current line must be reindented e.g. when Tab is pressed in emacs mode.
     * <br/>
     * The method should use information from the context and modify
     * indentation at the given offset in the document.
     * 
     * @throws BadLocationException in case the indent task attempted to insert/remove
     *  at an invalid offset or e.g. into a guarded section.
     */
    void reindent() throws BadLocationException;
    
    /**
     * Get an extra locking or null if no extra locking is necessary.
     */
    ExtraLock indentLock();

    /**
     * Indent task factory produces indent tasks for the given context.
     * <br/>
     * It should be registered in MimeLookup via xml layer in "/Editors/&lt;mime-type&gt;"
     * folder.
     */
    public interface Factory {

        /**
         * Create indenting task.
         *
         * @param context non-null indentation context.
         * @return indenting task or null if the factory cannot handle the given context.
         */
        IndentTask createTask(Context context);

    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.spi.editor.indent;

import javax.swing.text.BadLocationException;

/**
 * Reformat task performs actual reformatting within offset bounds of the given context.
 *
 * @author Miloslav Metelka
 */

public interface ReformatTask {

    /**
     * Perform reformatting of the {@link Context#getDocument()}
     * between {@link Context#startOffset()} and {@link Context#endOffset()}.
     * <br/>
     * This method may be called several times repetitively for different areas
     * of a reformatted area.
     * <br/>
     * It is called from AWT thread and it should process synchronously. It is used
     * after a newline is inserted after the user presses Enter
     * or when a current line must be reindented e.g. when Tab is pressed in emacs mode.
     * <br/>
     * The method should use information from the context and modify
     * indentation at the given offset in the document.
     * 
     * @throws BadLocationException in case the formatter attempted to insert/remove
     *  at an invalid offset or e.g. into a guarded section.
     */
    void reformat() throws BadLocationException;

    /**
     * Get an extra locking or null if no extra locking is necessary.
     */
    ExtraLock reformatLock();
    
    /**
     * Reformat task factory produces reformat tasks for the given context.
     * <br/>
     * It should be registered in MimeLookup via xml layer in "/Editors/&lt;mime-type&gt;"
     * folder.
     */
    public interface Factory {

        /**
         * Create reformatting task.
         *
         * @param context non-null indentation context.
         * @return reformatting task or null if the factory cannot handle the given context.
         */
        ReformatTask createTask(Context context);

    }

}

Added Link Here

(-)indent/test/.cvsignore (+3 lines)
1	lib
2	results
3	work




<?xml version="1.0"?>
<!--
The contents of this file are subject to the terms of the Common Development
and Distribution License (the License). You may not use this file except in
compliance with the License.

You can obtain a copy of the License at http://www.netbeans.org/cddl.html
or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file
and include the License file at http://www.netbeans.org/cddl.txt.
If applicable, add the following below the CDDL Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
Microsystems, Inc. All Rights Reserved.
-->
<project name="editor/indent test build script" basedir="." default="all">

    <!-- Name of tested module -->
    <property name="xtest.module" value="editor/indent"/>
    
    <!-- Imports buildtests, cleantests, runtest, cleanresults, realclean, printconfig targets. -->
    <import file="../../../nbbuild/templates/xtest.xml"/>
    <import file="../../../nbbuild/templates/xtest-unit.xml"/>
    
    <!-- default testtypes, attributes used when no value is supplied from command line -->
    <property name="xtest.testtype" value="unit"/>
    <property name="xtest.attribs" value="stable"/>

    <!-- Build lexer tests -->
    <target name="build-lexer-tests">
        <!--  Cannot use
              <ant dir="../../openide/text/test" target="buildtests" inheritall="false"/>
              because inheritAll="false" doesn't work for all properties. -->
        <java classname="org.apache.tools.ant.Main" classpath="${java.class.path}" fork="true">
            <arg value="-f"/>
            <arg value="../../../lexer/test/build.xml"/>
            <arg value="-Dxtest.testtype=unit"/>
            <arg value="-Dxtest.attribs=stable"/>
            <arg value="buildtests"/>
        </java>
    </target>
    
    <target name="default-compiler" depends="build-lexer-tests,xtest-unit.default-compiler"/>

    <target name="run-unit-test-noJIT">
        <antcall target="run-unit-test">
            <param name="xtest.jvm.args" value="-Xint" />
        </antcall>
    </target>
</project>




<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mconfig PUBLIC "-//NetBeans//DTD XTest cfg 1.0//EN" "http://www.netbeans.org/dtds/xtest-cfg-1_0.dtd">
<!--
The contents of this file are subject to the terms of the Common Development
and Distribution License (the License). You may not use this file except in
compliance with the License.

You can obtain a copy of the License at http://www.netbeans.org/cddl.html
or http://www.netbeans.org/cddl.txt.

When distributing Covered Code, include this CDDL Header Notice in each file
and include the License file at http://www.netbeans.org/cddl.txt.
If applicable, add the following below the CDDL Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

The Original Software is NetBeans. The Initial Developer of the Original
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
Microsystems, Inc. All Rights Reserved.
-->

<!-- 
  These classes are excluded by default (defined in build.xml):
    "**/*Suite.class"
    "**/*$$*.class"
    "**/data/**"
    "**/hidden/**"
    "**/*Hidden.*"
    "**/*Hid.*"
-->

<mconfig name="editor/indent unit test config">
    
    <testbag testattribs="stable" executor="code" name="testbag_1">
        <testset dir="unit/src">
            <patternset>
                <include name="**/**Test.class"/>
                <exclude name="org/netbeans/spi/editor/highlighting/performance/**"/>
            </patternset>
        </testset>
    </testbag>
    
    <testbag testattribs="failing" executor="code" name="testbag_2">
        <testset dir="unit/src">
            <patternset>
            </patternset>
        </testset>
    </testbag>
    
    <!-- If you want to use this testbag you *must* provide xtest.includes property, -->
    <!-- (either on cmd line or in the script) to explicitly define which test       -->
    <!-- you want to run. This will run *only* tests from unit/src folder !!!        -->
    <testbag testattribs="empty" executor="code" name="testbag_empty">
        <testset dir="unit/src"/>
    </testbag>

    <executor name="code" antfile="build.xml" target="run-unit-test" default="true"/>
    <executor name="code-noJIT" antfile="build.xml" target="run-unit-test-noJIT" />
    
    <compiler name="unit-compiler" antfile="build.xml" target="default-compiler" default="true"/>
    
</mconfig>

Added Link Here

(-)indent/test/unit/src/META-INF/services/org.netbeans.spi.editor.mimelookup.MimeDataProvider (+1 lines)
1	org.netbeans.modules.editor.indent.IndentTestMimeDataProvider




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.api.editor.indent;

import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.PlainDocument;
import org.netbeans.junit.NbTestCase;
import org.netbeans.modules.editor.indent.IndentTestMimeDataProvider;
import org.netbeans.spi.editor.indent.Context;
import org.netbeans.spi.editor.indent.ExtraLock;
import org.netbeans.spi.editor.indent.IndentTask;

/**
 *
 * @author Miloslav Metelka
 */
public class IndentTest extends NbTestCase {
    
    private static final String MIME_TYPE = "text/x-test";

    public IndentTest(String name) {
        super(name);
    }

    public void testFindIndentTaskFactory() throws BadLocationException {
        TestIndentTask.TestFactory factory = new TestIndentTask.TestFactory();
        IndentTestMimeDataProvider.addInstances(MIME_TYPE, factory);
        Document doc = new PlainDocument();
        doc.putProperty("mimeType", MIME_TYPE);
        Indent indent = Indent.get(doc);
        indent.lock();
        try {
            //doc.atomicLock();
            try {
                indent.reindent(0);
            } finally {
                //doc.atomicUnlock();
            }
        } finally {
            indent.unlock();
        }
        // Check that the factory was used
        assertTrue(factory.lastCreatedTask.indentPerformed);
    }

    private static final class TestIndentTask implements IndentTask {
        
        private Context context;
        
        TestExtraLocking lastCreatedLocking;
        
        boolean indentPerformed;

        TestIndentTask(Context context) {
            this.context = context;
        }

        public void reindent() throws BadLocationException {
            assertTrue(lastCreatedLocking.locked);
            context.document().insertString(0, " ", null);
            indentPerformed = true;
        }
        
        public ExtraLock indentLock() {
            return (lastCreatedLocking = new TestExtraLocking());
        }
        
        static final class TestFactory implements IndentTask.Factory {
            
            static TestIndentTask lastCreatedTask;

            public IndentTask createTask(Context context) {
                return (lastCreatedTask = new TestIndentTask(context));
            }
            
        }

    }
    
    private static final class TestExtraLocking implements ExtraLock {
        
        Boolean locked;
        
        public Boolean locked() {
            return locked;
        }

        public void lock() {
            if (locked != null)
                assertFalse(locked);
            locked = true;
        }

        public void unlock() {
            assertTrue(locked);
            locked = false;
        }
        
    }
}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.api.editor.indent;

import org.netbeans.junit.NbTestCase;
import org.netbeans.lib.editor.util.ArrayUtilities;

/**
 *
 * @author Miloslav Metelka
 */
public class IndentUtilsTest extends NbTestCase {
    
    private static final String MIME_TYPE = "text/x-test";

    public IndentUtilsTest(String name) {
        super(name);
    }

    public void testIndentUtils() throws Exception {
        // Test empty indent
        assertSame("", IndentUtils.cachedOrCreatedIndentString(0, true, 8));
        assertSame("", IndentUtils.cachedOrCreatedIndentString(0, false, 4));
        
        // Test <tabSize
        String s;
        assertEquals("   ", s = IndentUtils.cachedOrCreatedIndentString(3, false, 4));
        // Test caching of indent strings
        assertSame(s, IndentUtils.cachedOrCreatedIndentString(3, false, 4));
        
        // Test ==tabSize
        assertEquals("\t", s = IndentUtils.cachedOrCreatedIndentString(4, false, 4));
        assertSame(s, IndentUtils.cachedOrCreatedIndentString(4, false, 4));

        // Test >tabSize
        assertEquals("\t  ", s = IndentUtils.cachedOrCreatedIndentString(6, false, 4));
        assertSame(s, IndentUtils.cachedOrCreatedIndentString(6, false, 4));
        assertEquals("\t\t\t   ", s = IndentUtils.cachedOrCreatedIndentString(15, false, 4));
        assertSame(s, IndentUtils.cachedOrCreatedIndentString(15, false, 4));
        
        // Test spaces-only
        assertEquals("          ", s = IndentUtils.cachedOrCreatedIndentString(10, true, 4));
        assertEquals(s, IndentUtils.cachedOrCreatedIndentString(10, true, 4));
        
        // Test many (non-cached) spaces
        int testUncachedIndent = 90;
        StringBuilder sb = new StringBuilder(testUncachedIndent);
        ArrayUtilities.appendSpaces(sb, testUncachedIndent);
        assertEquals(sb.toString(), IndentUtils.cachedOrCreatedIndentString(testUncachedIndent, true, 4));
        
        // Test long (non-cached) tab indent
        int i = testUncachedIndent;
        sb.setLength(0);
        while (i >= 8) {
            sb.append('\t');
            i -= 8;
        }
        ArrayUtilities.appendSpaces(sb, i);
        assertEquals(sb.toString(), IndentUtils.cachedOrCreatedIndentString(testUncachedIndent, false, 8));
        
    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor.indent;

import java.awt.event.ActionEvent;
import javax.swing.Action;
import javax.swing.JEditorPane;
import javax.swing.SwingUtilities;
import org.netbeans.api.editor.indent.*;
import javax.swing.text.BadLocationException;
import org.netbeans.editor.BaseKit;
import org.netbeans.junit.NbTestCase;
import org.netbeans.modules.editor.NbEditorKit;
import org.netbeans.modules.editor.indent.IndentTestMimeDataProvider;
import org.netbeans.spi.editor.indent.Context;
import org.netbeans.spi.editor.indent.ExtraLock;
import org.netbeans.spi.editor.indent.IndentTask;

/**
 *
 * @author Miloslav Metelka
 */
public class IndentActionsTest extends NbTestCase {
    
    private static final String MIME_TYPE = "text/x-test-actions";

    public IndentActionsTest(String name) {
        super(name);
    }

    public void testIndentActions() {
        // Must run in AWT thread (BaseKit.install() checks for that)
        if (!SwingUtilities.isEventDispatchThread()) {
            SwingUtilities.invokeLater(
                new Runnable() {
                    public void run() {
                        testIndentActions();
                    }
                }
            );
            return;
        }

        assertTrue(SwingUtilities.isEventDispatchThread());
        TestIndentTask.TestFactory factory = new TestIndentTask.TestFactory();
        IndentTestMimeDataProvider.addInstances(MIME_TYPE, factory);
        TestKit kit = new TestKit();
        JEditorPane pane = new JEditorPane();
        pane.setEditorKit(kit);
        assertEquals(MIME_TYPE, pane.getDocument().getProperty("mimeType"));
        //doc.putProperty("mimeType", MIME_TYPE);
        
        // Test insert new line action
        Action a = kit.getActionByName(BaseKit.insertBreakAction);
        assertNotNull(a);
        a.actionPerformed(new ActionEvent(pane, 0, ""));
        // Check that the factory was used
        assertTrue(factory.lastCreatedTask.indentPerformed);

        // Test reformat action
         a = kit.getActionByName(BaseKit.formatAction);
        assertNotNull(a);
        a.actionPerformed(new ActionEvent(pane, 0, ""));

    }

    private static final class TestIndentTask implements IndentTask {
        
        private Context context;
        
        TestExtraLocking lastCreatedLocking;
        
        boolean indentPerformed;

        TestIndentTask(Context context) {
            this.context = context;
        }

        public void reindent() throws BadLocationException {
            assertTrue(lastCreatedLocking.locked);
            context.document().insertString(0, " ", null);
            indentPerformed = true;
        }
        
        public ExtraLock indentLock() {
            return (lastCreatedLocking = new TestExtraLocking());
        }
        
        static final class TestFactory implements IndentTask.Factory {
            
            static TestIndentTask lastCreatedTask;

            public IndentTask createTask(Context context) {
                return (lastCreatedTask = new TestIndentTask(context));
            }
            
        }

    }
    
    private static final class TestExtraLocking implements ExtraLock {
        
        Boolean locked;
        
        public Boolean locked() {
            return locked;
        }

        public void lock() {
            if (locked != null)
                assertFalse(locked);
            locked = true;
        }

        public void unlock() {
            assertTrue(locked);
            locked = false;
        }
        
    }
    
    private static final class TestKit extends NbEditorKit {
        
        public String getContentType() {
            return MIME_TYPE;
        }
        
    }
}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor.indent;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import org.netbeans.api.editor.mimelookup.MimePath;
import org.netbeans.spi.editor.mimelookup.MimeDataProvider;
import org.openide.util.Lookup;
import org.openide.util.lookup.AbstractLookup;
import org.openide.util.lookup.InstanceContent;

/**
 * Testing mime data provider.
 *
 * @author vita
 */
public final class IndentTestMimeDataProvider implements MimeDataProvider {
    
    private static final HashMap<String, Lkp> CACHE = new HashMap<String, Lkp>();
    
    /** Creates a new instance of MemoryMimeDataProvider */
    public IndentTestMimeDataProvider() {
    }

    public Lookup getLookup(MimePath mimePath) {
        return getLookup(mimePath.getPath(), true);
    }
    
    public static void addInstances(String mimePath, Object... instances) {
        assert mimePath != null : "Mime path can't be null";
        getLookup(mimePath, true).addInstances(instances);
    }
    
    public static void removeInstances(String mimePath, Object... instances) {
        assert mimePath != null : "Mime path can't be null";
        getLookup(mimePath, true).removeInstances(instances);
    }
    
    public static void reset(String mimePath) {
        if (mimePath == null) {
            synchronized (CACHE) {
                for(Lkp lookup : CACHE.values()) {
                    lookup.reset();
                }
            }
        } else {
            Lkp lookup = getLookup(mimePath, false);
            if (lookup != null) {
                lookup.reset();
            }
        }
    }
    
    private static Lkp getLookup(String mimePath, boolean create) {
        synchronized (CACHE) {
            Lkp lookup = CACHE.get(mimePath);
            if (lookup == null && create) {
                lookup = new Lkp();
                CACHE.put(mimePath, lookup);
            }
            return lookup;
        }
    }
    
    private static final class Lkp extends AbstractLookup {
        
        private ArrayList<Object> all = new ArrayList<Object>();
        private InstanceContent contents;
            
        public Lkp() {
            this(new InstanceContent());
        }
        
        private Lkp(InstanceContent ic) {
            super(ic);
            this.contents = ic;
        }
        
        public void addInstances(Object... instances) {
            all.addAll(Arrays.asList(instances));
            contents.set(all, null);
        }

        public void removeInstances(Object... instances) {
            ArrayList<Object> newAll = new ArrayList<Object>();
            
            loop:
            for(Object oo : all) {
                for(Object o : instances) {
                    if (o == oo) {
                        continue loop;
                    }
                }
                
                newAll.add(oo);
            }
            
            all = newAll;
            contents.set(all, null);
        }
        
        public void reset() {
            all.clear();
            contents.set(all, null);
        }
    } // End of Lkp class
}




                Cursor origCursor = target.getCursor();
                target.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));

                Formatter formatter = doc.getFormatter();
                formatter.reformatLock();
                try {
                    doc.atomicLock();
                    try {

                        int startPos;
                        Position endPosition;
                        if (caret.isSelectionVisible()) {
                            startPos = target.getSelectionStart();
                            endPosition = doc.createPosition(target.getSelectionEnd());
                        } else {
                            startPos = 0;
                            endPosition = doc.createPosition(doc.getLength());
                        }

                        int pos = startPos;
                        if (gdoc != null) {
                            pos = gdoc.getGuardedBlockChain().adjustToBlockEnd(pos);
                        }

                        while (pos < endPosition.getOffset()) {
                            int stopPos = endPosition.getOffset();
                            if (gdoc != null) { // adjust to start of the next guarded block
                                stopPos = gdoc.getGuardedBlockChain().adjustToNextBlockStart(pos);
                                if (stopPos == -1 || stopPos > endPosition.getOffset()) {
                                    stopPos = endPosition.getOffset();
                                }
                            }
                        }

                            int reformattedLen = formatter.reformat(doc, pos, stopPos);
                            pos = pos + reformattedLen;

                            if (gdoc != null) { // adjust to end of current block
                                pos = gdoc.getGuardedBlockChain().adjustToBlockEnd(pos);
                            }
                        }
                    }

                    } catch (GuardedException e) {
                        target.getToolkit().beep();
                    } catch (BadLocationException e) {
                        Utilities.annotateLoggable(e);
                    } finally {
                        doc.atomicUnlock();
                        target.setCursor(origCursor);
                    }
                } finally {
                    formatter.reformatUnlock();
                    target.setCursor(origCursor);
                }
            }
        }

Lines 52-57 Link Here

(-)libsrc/org/netbeans/editor/BaseDocument.java (-1 / +7 lines)
52	import javax.swing.undo.CannotUndoException;	52	import javax.swing.undo.CannotUndoException;
53	import javax.swing.undo.CannotRedoException;	53	import javax.swing.undo.CannotRedoException;
54	import org.netbeans.lib.editor.util.swing.DocumentListenerPriority;	54	import org.netbeans.lib.editor.util.swing.DocumentListenerPriority;
		55	import org.netbeans.modules.editor.lib.FormatterOverride;
		56	import org.openide.util.Lookup;
55		57
56	/**	58	/**
57	* Document implementation	59	* Document implementation
Lines 439-445 Link Here
439		441
440	/** Get the formatter for this document. */	442	/** Get the formatter for this document. */
441	public Formatter getFormatter() {	443	public Formatter getFormatter() {
442	return Formatter.getFormatter(kitClass);	444	Formatter f = (Formatter)getProperty("defaultFormatter");
		445	if (f == null)
		446	f = Formatter.getFormatter(kitClass);
		447	FormatterOverride fp = Lookup.getDefault().lookup(FormatterOverride.class);
		448	return (fp != null) ? fp.getFormatter(this, f) : f;
443	}	449	}
444		450
445	public SyntaxSupport getSyntaxSupport() {	451	public SyntaxSupport getSyntaxSupport() {




                }

                BaseDocument doc = (BaseDocument)target.getDocument();
                Formatter formatter = doc.getFormatter();
                formatter.indentLock();
                try {
                    doc.atomicLock();
                    DocumentUtilities.setTypingModification(doc, true);
                    try {
                        target.replaceSelection("");
                        Caret caret = target.getCaret();
                        Object cookie = beforeBreak(target, doc, caret);

                        int dotPos = caret.getDot();
                        int newDotPos = doc.getFormatter().indentNewLine(doc, dotPos);
                        caret.setDot(newDotPos);

                        afterBreak(target, doc, caret, cookie);
                    } finally {
                        DocumentUtilities.setTypingModification(doc, false);
                        doc.atomicUnlock();
                    }
                } finally {
                    formatter.indentUnlock();
                    doc.atomicUnlock();
                }
            }
        }




        return writer;
    }

    /**
     * Formatter clients should call this method
     * before acquiring of the document's write lock
     * and using of the {@link #indentLine(Document,int)}
     * and {@link #indentNewLine(Document,int)} methods.
     * <br/>
     * Subclasses may override this method
     * and perform necessary pre-locking (e.g. of java infrastructure).
     * <br/>
     * The following pattern should be used:
     * <pre>
     * formatter.indentLock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         formatter.indentLine(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     formatter.indentUnlock();
     * }
     * </pre>
     */
    public void indentLock() {
        // No extra locking by default
    }
    
    /**
     * Formatter clients should call this method 
     * after releasing of the document's write lock
     * as a counterpart of {@link #indentLock()}.
     * <br/>
     * Subclasses may override this method
     * and perform necessary post-unlocking (e.g. of java infrastructure).
     * <br/>
     * The following pattern should be used:
     * <pre>
     * formatter.indentLock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         formatter.indentLine(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     formatter.indentUnlock();
     * }
     * </pre>
     */
    public void indentUnlock() {
        // No extra locking by default
    }

    /**
     * Formatter clients should call this method 
     * before acquiring of the document's write lock
     * before using of {@link #reformat(BaseDocument,int,int)} method.
     * <br/>
     * Subclasses may override this method
     * and perform necessary pre-locking (e.g. of java infrastructure).
     * <br/>
     * The following pattern should be used:
     * <pre>
     * formatter.reformatLock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         formatter.reformat(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     formatter.reformatUnlock();
     * }
     * </pre>
     */
    public void reformatLock() {
        // No extra locking by default
    }
    
    /**
     * Formatter clients should call this method 
     * after releasing of the document's write lock
     * as a counterpart of {@link #reformatLock()}.
     * <br/>
     * Subclasses may override this method
     * and perform necessary post-unlocking (e.g. of java infrastructure).
     * <br/>
     * The following pattern should be used:
     * <pre>
     * formatter.reformatLock();
     * try {
     *     doc.atomicLock();
     *     try {
     *         formatter.reformat(...);
     *     } finally {
     *         doc.atomicUnlock();
     *     }
     * } finally {
     *     formatter.reformatUnlock();
     * }
     * </pre>
     */
    public void reformatUnlock() {
        // No extra locking by default
    }

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor.lib;

import javax.swing.text.Document;
import org.netbeans.editor.Formatter;

/**
 * Class to be searched in lookup that can override a formatter for the given document.
 * <br/>
 * It is a private contract between editor/lib and editor/indent.
 *
 * @author Miloslav Metelka
 */
public interface FormatterOverride {

    /**
     * Possibly override the default formatter used for the given document.
     * 
     * @param doc non-null document for which the formatter is being searched.
     * @param defaultFormatter default formatter found by the infrastructure
     *   or null if there is none.
     * @return overriden formatter or the default formatter passed as the argument.
     */
    Formatter getFormatter(Document doc, Formatter defaultFormatter);

}




/*
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 * or http://www.netbeans.org/cddl.txt.
 *
 * When distributing Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://www.netbeans.org/cddl.txt.
 * If applicable, add the following below the CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.editor;

import java.awt.Font;
import java.awt.Color;
import java.awt.Component;
import java.util.ArrayList;
import java.util.HashMap;
import java.text.AttributedCharacterIterator;
import javax.swing.text.AttributeSet;
import javax.swing.JEditorPane;
import org.netbeans.editor.BaseKit;
import org.netbeans.editor.GuardedDocument;
import org.netbeans.editor.PrintContainer;
import org.netbeans.editor.Formatter;
import org.netbeans.editor.Settings;
import org.netbeans.editor.SettingsChangeEvent;
import org.netbeans.editor.Utilities;
import org.openide.text.NbDocument;
import org.openide.text.AttributedCharacters;
import javax.swing.text.Position;
import org.openide.text.Annotation;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeEvent;
import java.util.Dictionary;
import java.util.Map;
import java.util.WeakHashMap;
import javax.swing.JToolBar;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.netbeans.editor.BaseDocument;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import org.netbeans.editor.AnnotationDesc;

/**
* BaseDocument extension managing the readonly blocks of text
*
* @author Miloslav Metelka
* @version 1.00
*/

public class NbEditorDocument extends GuardedDocument
implements NbDocument.PositionBiasable, NbDocument.WriteLockable,
NbDocument.Printable, NbDocument.CustomEditor, NbDocument.CustomToolbar, NbDocument.Annotatable {

    /** Name of the formatter setting. */
    public static final String FORMATTER = "formatter"; // NOI18N

    /** Mime type of the document. The name of this property corresponds
     * to the property that is filled in the document by CloneableEditorSupport.
     */
    public static final String MIME_TYPE_PROP = "mimeType"; // NOI18N

    /** Indent engine for the given kitClass. */
    public static final String INDENT_ENGINE = "indentEngine"; // NOI18N

    /** Formatter being used. */
    private Formatter formatter;

    /** Map of [Annotation, AnnotationDesc] */
    private HashMap annoMap;

    // #39718 hotfix
    private WeakHashMap annoBlackList;

    public NbEditorDocument(Class kitClass) {
        super(kitClass);
        addStyleToLayerMapping(NbDocument.BREAKPOINT_STYLE_NAME,
                               NbDocument.BREAKPOINT_STYLE_NAME + "Layer:10"); // NOI18N
        addStyleToLayerMapping(NbDocument.ERROR_STYLE_NAME,
                               NbDocument.ERROR_STYLE_NAME + "Layer:20"); // NOI18N
        addStyleToLayerMapping(NbDocument.CURRENT_STYLE_NAME,
                               NbDocument.CURRENT_STYLE_NAME + "Layer:30"); // NOI18N
        setNormalStyleName(NbDocument.NORMAL_STYLE_NAME);
        
        annoMap = new HashMap(20);
        annoBlackList = new WeakHashMap();
    }

    public void settingsChange(SettingsChangeEvent evt) {
        super.settingsChange(evt);

        // Check whether the mimeType is set
        Object o = getProperty(MIME_TYPE_PROP);
        if (!(o instanceof String)) {
            BaseKit kit = BaseKit.getKit(getKitClass());
            putProperty(MIME_TYPE_PROP, kit.getContentType());
        }

        // Fill in the indentEngine property
        putProperty(INDENT_ENGINE,
            new BaseDocument.PropertyEvaluator() {

                private Object cached;

                public Object getValue() {
                    if (cached == null) {
                        cached = Settings.getValue(getKitClass(), INDENT_ENGINE);
                    }
                    
                    return cached;
                }
            }
        );

        // Refresh formatter
        formatter = null;

    }

    public void setCharacterAttributes(int offset, int length, AttributeSet s,
                                       boolean replace) {
        if (s != null) {
            Object val = s.getAttribute(NbDocument.GUARDED);
            if (val != null && val instanceof Boolean) {
                if (((Boolean)val).booleanValue() == true) { // want make guarded
                    super.setCharacterAttributes(offset, length, guardedSet, replace);
                } else { // want make unguarded
                    super.setCharacterAttributes(offset, length, unguardedSet, replace);
                }
            } else { // not special values, just pass
                super.setCharacterAttributes(offset, length, s, replace);
            }
        }
    }

    public java.text.AttributedCharacterIterator[] createPrintIterators() {
        NbPrintContainer npc = new NbPrintContainer();
        print(npc);
        return npc.getIterators();
    }

    public Component createEditor(JEditorPane j) {
        return Utilities.getEditorUI(j).getExtComponent();
    }

    public JToolBar createToolbar(JEditorPane j) {
        return Utilities.getEditorUI(j).getToolBarComponent();
    }
    
    public Formatter getFormatter() {
        Formatter f = formatter;
        if (f == null) {
            formatter = (Formatter)Settings.getValue(getKitClass(), FORMATTER);
            f = formatter;
        }
        putProperty("defaultFormatter", f);
        // The super implementation will inspect "defaultFormatter" property
        return super.getFormatter();
    }

    /** Add annotation to the document. For annotation of whole line
     * the length parameter can be ignored (specify value -1).
     * @param startPos position which represent begining 
     * of the annotated text
     * @param length length of the annotated text. If -1 is specified 
     * the whole line will be annotated
     * @param annotation annotation which is attached to this text */
    public void addAnnotation(Position startPos, int length, Annotation annotation) {
        Integer count = (Integer)annoBlackList.get(annotation);
        if (count != null) {
            // #39718 hotfix - test whether the annotation was already removed; if so, just remove it from the black list and return
            if (count.intValue() == -1) {
                annoBlackList.remove(annotation);
                return;
            } else if (count.intValue() < -1) {
                annoBlackList.put(annotation, new Integer(count.intValue() + 1));
                return;
            }
        }
        // partial fix of #33165 - read-locking of the document added
        // BTW should only be invoked in EQ - see NbDocument.addAnnotation()
        readLock();
        try {
            // Recreate annotation's position to make sure it's in this doc at a valid offset
            int docLen = getLength();
            int offset = startPos.getOffset();
            offset = Math.min(offset, docLen);
            try {
                startPos = createPosition(offset);
            } catch (BadLocationException e) {
                startPos = null; // should never happen
            }
            
            AnnotationDescDelegate a = (AnnotationDescDelegate)annoMap.get(annotation);
            if (a != null) { // already added before
                // #39718 hotfix - remove the original annotation descriptor and put the annotation on the black list
                a.detachListeners();
                getAnnotations().removeAnnotation(a);
                annoMap.remove(annotation);
                annoBlackList.put(annotation, new Integer(count != null ? count.intValue() + 1 : 1));
            }
            if (annotation.getAnnotationType() != null) {
                a = new AnnotationDescDelegate(this, startPos, length, annotation);
                annoMap.put(annotation, a);
                getAnnotations().addAnnotation(a);
            }
        } finally {
            readUnlock();
        }
    }

    /** Removal of added annotation.
     * @param annotation annotation which is going to be removed */
    public void removeAnnotation(Annotation annotation) {
        if (annotation == null) { // issue 14803
            return; // can't do more as the rest of stacktrace is in openide and ant
        }

        Integer count = (Integer)annoBlackList.get(annotation);
        if (count != null) {
            // #39718 hotfix - test whether the annotation was already removed; if so, just remove it from the black list and return
            if (count.intValue() == 1) {
                annoBlackList.remove(annotation);
                return;
            } else if (count.intValue() > 1) {
                annoBlackList.put(annotation, new Integer(count.intValue() - 1));
                return;
            }
        }
        // partial fix of #33165 - read-locking of the document added
        // BTW should only be invoked in EQ - see NbDocument.removeAnnotation()
        readLock();
        try {
            if (annotation.getAnnotationType() != null) {
                AnnotationDescDelegate a = (AnnotationDescDelegate)annoMap.get(annotation);
                if (a == null) { // not added yet
                    // #39718 hotfix - put the annotation on the black list and return
                    annoBlackList.put(annotation, new Integer(count != null ? count.intValue() - 1 : -1));
                    return;
                }
                a.detachListeners();
                getAnnotations().removeAnnotation(a);
                annoMap.remove(annotation);
            }
        } finally {
            readUnlock();
        }
    }
    
    Map getAnnoMap(){
        return annoMap;
    }

    void addStreamDescriptionChangeListener(ChangeListener l) {
        listenerList.add(ChangeListener.class, l);
    }
    
    void removeStreamDescriptionChangeListener(ChangeListener l) {
        listenerList.remove(ChangeListener.class, l);
    }
    
    private void fireStreamDescriptionChange() {
        ChangeEvent evt = new ChangeEvent(this);
        Object[] listeners = listenerList.getListenerList();
        for (int i = listeners.length - 2; i >= 0; i -= 2) {
            if (listeners[i] == ChangeListener.class) {
                ((ChangeListener)listeners[i + 1]).stateChanged(evt);
            }
        }
    }

    protected Dictionary createDocumentProperties(Dictionary origDocumentProperties) {
        return new LazyPropertyMap(origDocumentProperties) {
            public Object put(Object key, Object value) {
                Object origValue = super.put(key, value);
                if (Document.StreamDescriptionProperty.equals(key)) {
                    if (origValue == null || !origValue.equals(value)) {
                        fireStreamDescriptionChange();
                    }
                }
                
                return origValue;
            }
        };
    }

    /** Implementation of AnnotationDesc, which delegate to Annotation instance
     * defined in org.openide.text package.
     */
    static class AnnotationDescDelegate extends AnnotationDesc {
        
        private Annotation delegate;
        private PropertyChangeListener l;
        private Position pos;
        private BaseDocument doc;
        
        AnnotationDescDelegate(BaseDocument doc, Position pos, int length, Annotation anno) {
            super(pos.getOffset(),length);
            this.pos = pos;
            this.delegate = anno;
            this.doc = doc;
            
            // update AnnotationDesc.type member
            updateAnnotationType();
            
            // forward property changes to AnnotationDesc property changes
            l = new PropertyChangeListener() {
                public void propertyChange (PropertyChangeEvent evt) {
                    if (evt.getPropertyName() == Annotation.PROP_SHORT_DESCRIPTION)
                        firePropertyChange(AnnotationDesc.PROP_SHORT_DESCRIPTION, null, null);
                    if (evt.getPropertyName() == Annotation.PROP_MOVE_TO_FRONT)
                        firePropertyChange(AnnotationDesc.PROP_MOVE_TO_FRONT, null, null);
                    if (evt.getPropertyName() == Annotation.PROP_ANNOTATION_TYPE) {
                        updateAnnotationType();
                        firePropertyChange(AnnotationDesc.PROP_ANNOTATION_TYPE, null, null);
                    }
                }
            };
            delegate.addPropertyChangeListener(l);
        }
        
        public String getAnnotationType() {
            return delegate.getAnnotationType();
        }
        
        public String getShortDescription() {
            return delegate.getShortDescription();
        }
        
        void detachListeners() {
            delegate.removePropertyChangeListener(l);
        }

        public int getOffset() {
            return pos.getOffset();
        }
        
        public int getLine() {
            try {
                return Utilities.getLineOffset(doc, pos.getOffset());
            } catch (BadLocationException e) {
                return 0;
            }
        }
        
    }
    
    
    class NbPrintContainer extends AttributedCharacters implements PrintContainer {

        ArrayList acl = new ArrayList();

        AttributedCharacters a;

        NbPrintContainer() {
            a = new AttributedCharacters();
        }

        public void add(char[] chars, Font font, Color foreColor, Color backColor) {
            a.append(chars, font, foreColor);
        }

        public void eol() {
            acl.add(a);
            a = new AttributedCharacters();
        }

        public boolean initEmptyLines() {
            return true;
        }

        public AttributedCharacterIterator[] getIterators() {
            int cnt = acl.size();
            AttributedCharacterIterator[] acis = new AttributedCharacterIterator[cnt];
            for (int i = 0; i < cnt; i++) {
                AttributedCharacters ac = (AttributedCharacters)acl.get(i);
                acis[i] = ac.iterator();
            }
            return acis;
        }

    }

}

Return to bug 91718

Lines 1483-1530 Link Here

(-)libsrc/org/netbeans/editor/ActionFactory.java (-32 / +38 lines)
1483	Cursor origCursor = target.getCursor();	1483	Cursor origCursor = target.getCursor();
1484	target.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));	1484	target.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
1485		1485
1486	doc.atomicLock();	1486	Formatter formatter = doc.getFormatter();
		1487	formatter.reformatLock();
1487	try {	1488	try {
		1489	doc.atomicLock();
		1490	try {
1488		1491
1489	int startPos;	1492	int startPos;
1490	Position endPosition;	1493	Position endPosition;
1491	if (caret.isSelectionVisible()) {	1494	if (caret.isSelectionVisible()) {
1492	startPos = target.getSelectionStart();	1495	startPos = target.getSelectionStart();
1493	endPosition = doc.createPosition(target.getSelectionEnd());	1496	endPosition = doc.createPosition(target.getSelectionEnd());
1494	} else {	1497	} else {
1495	startPos = 0;	1498	startPos = 0;
1496	endPosition = doc.createPosition(doc.getLength());	1499	endPosition = doc.createPosition(doc.getLength());
1497	}	1500	}
1498		1501
1499	int pos = startPos;	1502	int pos = startPos;
1500	if (gdoc != null) {	1503	if (gdoc != null) {
1501	pos = gdoc.getGuardedBlockChain().adjustToBlockEnd(pos);	1504	pos = gdoc.getGuardedBlockChain().adjustToBlockEnd(pos);
1502	}	1505	}
1503		1506
1504	while (pos < endPosition.getOffset()) {	1507	while (pos < endPosition.getOffset()) {
1505	int stopPos = endPosition.getOffset();	1508	int stopPos = endPosition.getOffset();
1506	if (gdoc != null) { // adjust to start of the next guarded block	1509	if (gdoc != null) { // adjust to start of the next guarded block
1507	stopPos = gdoc.getGuardedBlockChain().adjustToNextBlockStart(pos);	1510	stopPos = gdoc.getGuardedBlockChain().adjustToNextBlockStart(pos);
1508	if (stopPos == -1 \|\| stopPos > endPosition.getOffset()) {	1511	if (stopPos == -1 \|\| stopPos > endPosition.getOffset()) {
1509	stopPos = endPosition.getOffset();	1512	stopPos = endPosition.getOffset();
		1513	}
1510	}	1514	}
1511	}
1512		1515
1513	int reformattedLen = doc.getFormatter().reformat(doc, pos, stopPos);	1516	int reformattedLen = formatter.reformat(doc, pos, stopPos);
1514	pos = pos + reformattedLen;	1517	pos = pos + reformattedLen;
1515		1518
1516	if (gdoc != null) { // adjust to end of current block	1519	if (gdoc != null) { // adjust to end of current block
1517	pos = gdoc.getGuardedBlockChain().adjustToBlockEnd(pos);	1520	pos = gdoc.getGuardedBlockChain().adjustToBlockEnd(pos);
		1521	}
1518	}	1522	}
1519	}
1520		1523
1521	} catch (GuardedException e) {	1524	} catch (GuardedException e) {
1522	target.getToolkit().beep();	1525	target.getToolkit().beep();
1523	} catch (BadLocationException e) {	1526	} catch (BadLocationException e) {
1524	Utilities.annotateLoggable(e);	1527	Utilities.annotateLoggable(e);
		1528	} finally {
		1529	doc.atomicUnlock();
		1530	target.setCursor(origCursor);
		1531	}
1525	} finally {	1532	} finally {
1526	doc.atomicUnlock();	1533	formatter.reformatUnlock();
1527	target.setCursor(origCursor);
1528	}	1534	}
1529	}	1535	}
1530	}	1536	}

Lines 1112-1132 Link Here

(-)libsrc/org/netbeans/editor/BaseKit.java (-12 / +18 lines)
1112	}	1112	}
1113		1113
1114	BaseDocument doc = (BaseDocument)target.getDocument();	1114	BaseDocument doc = (BaseDocument)target.getDocument();
1115	doc.atomicLock();	1115	Formatter formatter = doc.getFormatter();
1116	DocumentUtilities.setTypingModification(doc, true);	1116	formatter.indentLock();
1117	try{	1117	try {
1118	target.replaceSelection("");	1118	doc.atomicLock();
1119	Caret caret = target.getCaret();	1119	DocumentUtilities.setTypingModification(doc, true);
1120	Object cookie = beforeBreak(target, doc, caret);	1120	try {
		1121	target.replaceSelection("");
		1122	Caret caret = target.getCaret();
		1123	Object cookie = beforeBreak(target, doc, caret);
1121		1124
1122	int dotPos = caret.getDot();	1125	int dotPos = caret.getDot();
1123	int newDotPos = doc.getFormatter().indentNewLine(doc, dotPos);	1126	int newDotPos = doc.getFormatter().indentNewLine(doc, dotPos);
1124	caret.setDot(newDotPos);	1127	caret.setDot(newDotPos);
1125		1128
1126	afterBreak(target, doc, caret, cookie);	1129	afterBreak(target, doc, caret, cookie);
		1130	} finally {
		1131	DocumentUtilities.setTypingModification(doc, false);
		1132	doc.atomicUnlock();
		1133	}
1127	} finally {	1134	} finally {
1128	DocumentUtilities.setTypingModification(doc, false);	1135	formatter.indentUnlock();
1129	doc.atomicUnlock();
1130	}	1136	}
1131	}	1137	}
1132	}	1138	}

Lines 497-500 Link Here

(-)libsrc/org/netbeans/editor/Formatter.java (+109 lines)
497	return writer;	497	return writer;
498	}	498	}
499		499
		500	/**
		501	* Formatter clients should call this method
		502	* before acquiring of the document's write lock
		503	* and using of the {@link #indentLine(Document,int)}
		504	* and {@link #indentNewLine(Document,int)} methods.
		505	* <br/>
		506	* Subclasses may override this method
		507	* and perform necessary pre-locking (e.g. of java infrastructure).
		508	* <br/>
		509	* The following pattern should be used:
		510	* <pre>
		511	* formatter.indentLock();
		512	* try {
		513	* doc.atomicLock();
		514	* try {
		515	* formatter.indentLine(...);
		516	* } finally {
		517	* doc.atomicUnlock();
		518	* }
		519	* } finally {
		520	* formatter.indentUnlock();
		521	* }
		522	* </pre>
		523	*/
		524	public void indentLock() {
		525	// No extra locking by default
		526	}
		527
		528	/**
		529	* Formatter clients should call this method
		530	* after releasing of the document's write lock
		531	* as a counterpart of {@link #indentLock()}.
		532	* <br/>
		533	* Subclasses may override this method
		534	* and perform necessary post-unlocking (e.g. of java infrastructure).
		535	* <br/>
		536	* The following pattern should be used:
		537	* <pre>
		538	* formatter.indentLock();
		539	* try {
		540	* doc.atomicLock();
		541	* try {
		542	* formatter.indentLine(...);
		543	* } finally {
		544	* doc.atomicUnlock();
		545	* }
		546	* } finally {
		547	* formatter.indentUnlock();
		548	* }
		549	* </pre>
		550	*/
		551	public void indentUnlock() {
		552	// No extra locking by default
		553	}
		554
		555	/**
		556	* Formatter clients should call this method
		557	* before acquiring of the document's write lock
		558	* before using of {@link #reformat(BaseDocument,int,int)} method.
		559	* <br/>
		560	* Subclasses may override this method
		561	* and perform necessary pre-locking (e.g. of java infrastructure).
		562	* <br/>
		563	* The following pattern should be used:
564	* <pre>
565	* formatter.reformatLock();
566	* try {
567	* doc.atomicLock();
568	* try {
569	* formatter.reformat(...);
570	* } finally {
571	* doc.atomicUnlock();
572	* }
573	* } finally {
574	* formatter.reformatUnlock();
575	* }
576	* </pre>
577	*/
578	public void reformatLock() {
579	// No extra locking by default
580	}
581
582	/**
583	* Formatter clients should call this method
584	* after releasing of the document's write lock
585	* as a counterpart of {@link #reformatLock()}.
586	* <br/>
587	* Subclasses may override this method
588	* and perform necessary post-unlocking (e.g. of java infrastructure).
589	* <br/>
590	* The following pattern should be used:
591	* <pre>
592	* formatter.reformatLock();
593	* try {
594	* doc.atomicLock();
595	* try {
596	* formatter.reformat(...);
597	* } finally {
598	* doc.atomicUnlock();
599	* }
600	* } finally {
601	* formatter.reformatUnlock();
602	* }
603	* </pre>
604	*/
605	public void reformatUnlock() {
606	// No extra locking by default
607	}
608
500	}	609	}

Added Link Here

(-)indent/apichanges.xml (+123 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!--
3	The contents of this file are subject to the terms of the Common Development
4	and Distribution License (the License). You may not use this file except in
5	compliance with the License.
6
7	You can obtain a copy of the License at http://www.netbeans.org/cddl.html
8	or http://www.netbeans.org/cddl.txt.
9
10	When distributing Covered Code, include this CDDL Header Notice in each file
11	and include the License file at http://www.netbeans.org/cddl.txt.
12	If applicable, add the following below the CDDL Header, with the fields
13	enclosed by brackets [] replaced by your own identifying information:
14	"Portions Copyrighted [year] [name of copyright owner]"
15
16	The Original Software is NetBeans. The Initial Developer of the Original
17	Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
18	Microsystems, Inc. All Rights Reserved.
19	-->
20	<?xml-stylesheet type="text/xml" href="../../nbbuild/javadoctools/apichanges.xsl"?>
21	<!DOCTYPE apichanges PUBLIC "-//NetBeans//DTD API changes list 1.0//EN" "../../nbbuild/javadoctools/apichanges.dtd">
22
23	<!--
24
25	INFO FOR PEOPLE ADDING CHANGES:
26
27	Check the DTD (apichanges.dtd) for details on the syntax. You do not
28	need to regenerate the HTML, as this is part of Javadoc generation; just
29	change the XML. Rough syntax of a change (several parts optional):
30
31	<change>
32	<api name="compiler"/>
33	<summary>Some brief description here, can use <b>XHTML</b></summary>
34	<version major="1" minor="99"/>
35	<date day="13" month="6" year="2001"/>
36	<author login="jrhacker"/>
37	<compatibility addition="yes"/>
38	<description>
39	The main description of the change here.
40	Again can use full <b>XHTML</b> as needed.
41	</description>
42	<class package="org.openide.compiler" name="DoWhatIWantCompiler"/>
43	<issue number="14309"/>
44	</change>
45
46	Also permitted elements: <package>, <branch>. <version> is API spec
47	version, recommended for all new changes. <compatibility> should say
48	if things were added/modified/deprecated/etc. and give all information
49	related to upgrading old code. List affected top-level classes and
50	link to issue numbers if applicable. See the DTD for more details.
51
52	Changes need not be in any particular order, they are sorted in various
53	ways by the stylesheet anyway.
54
55	Dates are assumed to mean "on the trunk". If you also make the same
56	change on a stabilization branch, use the <branch> tag to indicate this
57	and explain why the change was made on a branch in the <description>.
58
59	Please only change this file on the trunk! Rather: you can change it
60	on branches if you want, but these changes will be ignored; only the
61	trunk version of this file is important.
62
63	Deprecations do not count as incompatible, assuming that code using the
64	deprecated calls continues to see their documented behavior. But do
65	specify deprecation="yes" in <compatibility>.
66
67	This file is not a replacement for Javadoc: it is intended to list changes,
68	not describe the complete current behavior, for which ordinary documentation
69	is the proper place.
70
71	-->
72
73	<apichanges>
74
75	<!-- First, a list of API names you may use: -->
76	<apidefs>
77	<apidef name="general">General</apidef>
78	<!-- etc. -->
79	</apidefs>
80
81	<!-- ACTUAL CHANGES BEGIN HERE: -->
82
83	<changes>
84
85	<change id="created">
86	<summary>editor/indent module was created.</summary>
87	<version major="1" minor="0"/>
88	<date day="14" month="6" year="2007"/>
89	<author login="mmetelka"/>
90	<compatibility binary="compatible" source="compatible" semantic="compatible"/>
91	<description>
92	The module was created.
93	</description>
94	</change>
95
96	</changes>
97
98	<!-- Now the surrounding HTML text and document structure: -->
99
100	<htmlcontents>
101	<!-- Generated from apichanges.xml -->
102	<head>
103	<title>Change History of Editor Indentation API</title>
104	<link rel="stylesheet" href="prose.css" type="text/css"/>
105	</head>
106	<body>
107
108	<p class="overviewlink"><a href="overview-summary.html">Overview</a></p>
109
110	<h1>Introduction</h1>
111
112	<p>This document lists changes made to the <a href="overview-summary.html">Editor Indent API</a>.</p>
113
114	<!-- The actual lists of changes, as summaries and details: -->
115	<hr/>
116	<standard-changelists module-code-name="org.netbeans.modules.editor.indent/1"/>
117
118	<hr/><p>@FOOTER@</p>
119
120	</body>
121	</htmlcontents>
122
123	</apichanges>

Added Link Here

(-)indent/build.xml (+23 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!--
3	The contents of this file are subject to the terms of the Common Development
4	and Distribution License (the License). You may not use this file except in
5	compliance with the License.
6
7	You can obtain a copy of the License at http://www.netbeans.org/cddl.html
8	or http://www.netbeans.org/cddl.txt.
9
10	When distributing Covered Code, include this CDDL Header Notice in each file
11	and include the License file at http://www.netbeans.org/cddl.txt.
12	If applicable, add the following below the CDDL Header, with the fields
13	enclosed by brackets [] replaced by your own identifying information:
14	"Portions Copyrighted [year] [name of copyright owner]"
15
16	The Original Software is NetBeans. The Initial Developer of the Original
17	Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
18	Microsystems, Inc. All Rights Reserved.
19	-->
20
21	<project name="editor/indent" default="netbeans" basedir=".">
22	<import file="../../nbbuild/templates/projectized.xml"/>
23	</project>

Added Link Here

(-)indent/nbproject/project.properties (+24 lines)
1	# The contents of this file are subject to the terms of the Common Development
2	# and Distribution License (the License). You may not use this file except in
3	# compliance with the License.
4	#
5	# You can obtain a copy of the License at http://www.netbeans.org/cddl.html
6	# or http://www.netbeans.org/cddl.txt.
7	#
8	# When distributing Covered Code, include this CDDL Header Notice in each file
9	# and include the License file at http://www.netbeans.org/cddl.txt.
10	# If applicable, add the following below the CDDL Header, with the fields
11	# enclosed by brackets [] replaced by your own identifying information:
12	# "Portions Copyrighted [year] [name of copyright owner]"
13	#
14	# The Original Software is NetBeans. The Initial Developer of the Original
15	# Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
16	# Microsystems, Inc. All Rights Reserved.
17
18	javac.source=1.5
19	javac.compilerargs=-Xlint:unchecked
20	spec.version.base=1.0
21
22	javadoc.arch=${basedir}/arch.xml
23	javadoc.apichanges=${basedir}/apichanges.xml
24	javadoc.title=Editor Indentation

Added Link Here

(-)indent/nbproject/project.xml (+98 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!--
3	The contents of this file are subject to the terms of the Common Development
4	and Distribution License (the License). You may not use this file except in
5	compliance with the License.
6
7	You can obtain a copy of the License at http://www.netbeans.org/cddl.html
8	or http://www.netbeans.org/cddl.txt.
9
10	When distributing Covered Code, include this CDDL Header Notice in each file
11	and include the License file at http://www.netbeans.org/cddl.txt.
12	If applicable, add the following below the CDDL Header, with the fields
13	enclosed by brackets [] replaced by your own identifying information:
14	"Portions Copyrighted [year] [name of copyright owner]"
15
16	The Original Software is NetBeans. The Initial Developer of the Original
17	Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
18	Microsystems, Inc. All Rights Reserved.
19	-->
20	<project xmlns="http://www.netbeans.org/ns/project/1">
21	<type>org.netbeans.modules.apisupport.project</type>
22	<configuration>
23	<data xmlns="http://www.netbeans.org/ns/nb-module-project/2">
24	<code-name-base>org.netbeans.modules.editor.indent</code-name-base>
25	<module-dependencies>
26	<dependency>
27	<code-name-base>org.netbeans.modules.editor.lib</code-name-base>
28	<build-prerequisite/>
29	<compile-dependency/>
30	<run-dependency>
31	<release-version>1</release-version>
32	<implementation-version/>
33	</run-dependency>
34	</dependency>
35	<dependency>
36	<code-name-base>org.netbeans.modules.editor.mimelookup</code-name-base>
37	<build-prerequisite/>
38	<compile-dependency/>
39	<run-dependency>
40	<release-version>1</release-version>
41	<specification-version>1.5</specification-version>
42	</run-dependency>
43	</dependency>
44	<dependency>
45	<code-name-base>org.netbeans.modules.editor.util</code-name-base>
46	<build-prerequisite/>
47	<compile-dependency/>
48	<run-dependency>
49	<release-version>1</release-version>
50	<specification-version>1.17</specification-version>
51	</run-dependency>
52	</dependency>
53	<dependency>
54	<code-name-base>org.netbeans.modules.lexer</code-name-base>
55	<build-prerequisite/>
56	<compile-dependency/>
57	<run-dependency>
58	<release-version>2</release-version>
59	<specification-version>1.19</specification-version>
60	</run-dependency>
61	</dependency>
62	<dependency>
63	<code-name-base>org.openide.util</code-name-base>
64	<build-prerequisite/>
65	<compile-dependency/>
66	<run-dependency>
67	<specification-version>7.9</specification-version>
68	</run-dependency>
69	</dependency>
70	</module-dependencies>
71	<test-dependencies>
72	<test-type>
73	<name>unit</name>
74	<test-dependency>
75	<code-name-base>org.netbeans.modules.editor.indent</code-name-base>
76	<recursive/>
77	<compile-dependency/>
78	</test-dependency>
79	<test-dependency>
80	<code-name-base>org.netbeans.modules.editor</code-name-base>
81	<compile-dependency/>
82	</test-dependency>
83	<test-dependency>
84	<code-name-base>org.netbeans.modules.editor.lib</code-name-base>
85	<compile-dependency/>
86	</test-dependency>
87	</test-type>
88	<test-type>
89	<name>qa-functional</name>
90	</test-type>
91	</test-dependencies>
92	<public-packages>
93	<package>org.netbeans.api.editor.indent</package>
94	<package>org.netbeans.spi.editor.indent</package>
95	</public-packages>
96	</data>
97	</configuration>
98	</project>

Added Link Here

(-)indent/src/org/netbeans/api/editor/indent/Indent.java (+149 lines)
1	/*
2	* The contents of this file are subject to the terms of the Common Development
3	* and Distribution License (the License). You may not use this file except in
4	* compliance with the License.
5	*
6	* You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7	* or http://www.netbeans.org/cddl.txt.
8	*
9	* When distributing Covered Code, include this CDDL Header Notice in each file
10	* and include the License file at http://www.netbeans.org/cddl.txt.
11	* If applicable, add the following below the CDDL Header, with the fields
12	* enclosed by brackets [] replaced by your own identifying information:
13	* "Portions Copyrighted [year] [name of copyright owner]"
14	*
15	* The Original Software is NetBeans. The Initial Developer of the Original
16	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17	* Microsystems, Inc. All Rights Reserved.
18	*/
19
20	package org.netbeans.api.editor.indent;
21
22	import javax.swing.text.BadLocationException;
23	import javax.swing.text.Document;
24	import org.netbeans.modules.editor.indent.IndentImpl;
25
26	/**
27	* Reindentation of a single or multiple lines in the document
28	* means fixing of the line's indent only but does not do any other
29	* code beautification.
30	* <br/>
31	* The following pattern should be used:
32	* <pre>
33	* indent.lock();
34	* try {
35	* doc.atomicLock();
36	* try {
37	* indent.reindent(...);
38	* } finally {
39	* doc.atomicUnlock();
40	* }
41	* } finally {
42	* indent.unlock();
43	* }
44	* </pre>
45	*
46	* @author Miloslav Metelka
47	*/
48	public final class Indent {
49
50	/**
51	* Get the indentation for the given document.
52	*
53	* @param doc non-null document.
54	* @return non-null indentation.
55	*/
56	public static Indent get(Document doc) {
57	IndentImpl indentImpl = IndentImpl.get(doc);
58	Indent indent = indentImpl.getIndent();
59	if (indent == null) {
60	indent = new Indent(indentImpl);
61	indentImpl.setIndent(indent);
62	}
63	return indent;
64	}
65
66	private final IndentImpl impl;
67
68	private Indent(IndentImpl impl) {
69	this.impl = impl;
70	}
71
72	/**
73	* Clients should call this method before acquiring of document's write lock.
74	* <br/>
75	* The following pattern should be used:
76	* <pre>
77	* indent.lock();
78	* try {
79	* doc.atomicLock();
80	* try {
81	* indent.reindent(...);
82	* } finally {
83	* doc.atomicUnlock();
84	* }
85	* } finally {
86	* indent.unlock();
87	* }
88	* </pre>
89	*/
90	public void lock() {
91	impl.indentLock();
92	}
93
94	/**
95	* Clients should call this method after releasing of document's write lock.
96	* <br/>
97	* The following pattern should be used:
98	* <pre>
99	* indent.lock();
100	* try {
101	* doc.atomicLock();
102	* try {
103	* indent.reindent(...);
104	* } finally {
105	* doc.atomicUnlock();
106	* }
107	* } finally {
108	* indent.unlock();
109	* }
110	* </pre>
111	*/
112	public void unlock() {
113	impl.indentUnlock();
114	}
115
116	/**
117	* Correct indentation on a single line determined by the given offset.
118	* <br/>
119	* Typically it is called after newline gets inserted
120	* or when a line is reindented explicitly (e.g. by pressing TAB key in emacs mode).
121	* <br/>
122	* This method will fallback to the editor formatting infrastructure
123	* in case there are no registered indent or reformat factories.
124	*
125	* @param offset >=0 any offset on the line to be reformatted.
126	* @throws BadLocationException in case the indenter attempted to insert/remove
127	* at an invalid offset or e.g. into a guarded section.
128	*/
129	public void reindent(int offset) throws BadLocationException {
130	reindent(offset, offset);
131	}
132
133	/**
134	* Correct indentation of all lines in the given offset range.
135	* <br/>
136	* This method will fallback to the editor formatting infrastructure
137	* in case there are no registered indent or reformat factories.
138	*
139	* @param startOffset >=0 any offset on a first line to be reformatted.
140	* @param endOffset >=startOffset any offset (including end offset)
141	* on a last line to be reformatted.
142	* @throws BadLocationException in case the indenter attempted to insert/remove
143	* at an invalid offset or e.g. into a guarded section.
144	*/
145	public void reindent(int startOffset, int endOffset) throws BadLocationException {
146	impl.reindent(startOffset, endOffset);
147	}
148
149	}

Added Link Here

(-)indent/src/org/netbeans/modules/editor/indent/Bundle.properties (+22 lines)
1	# The contents of this file are subject to the terms of the Common Development
2	# and Distribution License (the License). You may not use this file except in
3	# compliance with the License.
4	#
5	# You can obtain a copy of the License at http://www.netbeans.org/cddl.html
6	# or http://www.netbeans.org/cddl.txt.
7	#
8	# When distributing Covered Code, include this CDDL Header Notice in each file
9	# and include the License file at http://www.netbeans.org/cddl.txt.
10	# If applicable, add the following below the CDDL Header, with the fields
11	# enclosed by brackets [] replaced by your own identifying information:
12	# "Portions Copyrighted [year] [name of copyright owner]"
13	#
14	# The Original Software is NetBeans. The Initial Developer of the Original
15	# Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
16	# Microsystems, Inc. All Rights Reserved.
17
18	OpenIDE-Module-Name=Editor Indentation
19	OpenIDE-Module-Display-Category=Editing
20	OpenIDE-Module-Short-Description=Contains indentation APIs and SPIs.
21	OpenIDE-Module-Long-Description=The module includes indenation and code formatting APIs and infrastructure.
22

Added Link Here

(-)indent/src/org/netbeans/spi/editor/indent/Context.java (+123 lines)
1	/*
2	* The contents of this file are subject to the terms of the Common Development
3	* and Distribution License (the License). You may not use this file except in
4	* compliance with the License.
5	*
6	* You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7	* or http://www.netbeans.org/cddl.txt.
8	*
9	* When distributing Covered Code, include this CDDL Header Notice in each file
10	* and include the License file at http://www.netbeans.org/cddl.txt.
11	* If applicable, add the following below the CDDL Header, with the fields
12	* enclosed by brackets [] replaced by your own identifying information:
13	* "Portions Copyrighted [year] [name of copyright owner]"
14	*
15	* The Original Software is NetBeans. The Initial Developer of the Original
16	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17	* Microsystems, Inc. All Rights Reserved.
18	*/
19
20	package org.netbeans.spi.editor.indent;
21
22	import javax.swing.text.Document;
23	import javax.swing.text.Position;
24	import org.netbeans.modules.editor.indent.IndentSpiPackageAccessor;
25
26
27	/**
28	* Context information for both indentation and reformatting.
29	* <br/>
30	* A common class allows to conveniently share code between indentation and reformatting.
31	* {@link #isIndent()} allows to check whether the actual processing
32	* is indentation or reformatting.
33	*
34	* @author Miloslav Metelka
35	*/
36
37	public final class Context {
38
39	static {
40	IndentSpiPackageAccessor.register(new PackageAccessor());
41	}
42
43	private final boolean indent;
44
45	private final Document doc;
46
47	private Position startPos;
48
49	private Position endPos;
50
51	Context(boolean indent, Document doc) {
52	this.indent = indent;
53	this.doc = doc;
54	this.startPos = startPos;
55	this.endPos = endPos;
56	}
57
58	/**
59	* Document for which the reformatting or indenting is being done.
60	*/
61	public Document document() {
62	return doc;
63	}
64
65	/**
66	* Starting offset of the area to be reformatted or reindented.
67	* <br/>
68	* The value gets updated accordingly when the reformatter performs modifications
69	* in the affected area.
70	*/
71	public int startOffset() {
72	return (startPos != null) ? startPos.getOffset() : -1;
73	}
74
75	/**
76	* Starting offset of the area to be reformatted or reindented.
77	* <br/>
78	* The value gets updated accordingly when the reformatter performs modifications
79	* in the affected area.
80	*/
81	public int endOffset() {
82	return (endPos != null) ? endPos.getOffset() : -1;
83	}
84
85	/**
86	* Modify indent of the line at the offset passed as the parameter.
87	*/
88	public void modifyIndent(int offset) {
89	// TBD
90	}
91
92	/*
93	* Check whether the actual processing
94	* is indentation or reformatting.
95	*
96	* <br/>
97	* Indent tasks may be used for reformatting in case a reformat task
98	* is not available (for the given mimepath) but the indent task is available.
99	*
100	* @return true if indentation is being done or false for reformatting.
101	*/
102	public boolean isIndent() {
103	return indent;
104	}
105
106	void resetBounds(Position startPos, Position endPos) {
107	this.startPos = startPos;
108	this.endPos = endPos;
109	}
110
111	private static final class PackageAccessor extends IndentSpiPackageAccessor {
112
113	public Context createContext(boolean indent, Document doc) {
114	return new Context(indent, doc);
115	}
116
117	public void resetBounds(Context ctx, Position startPos, Position endPos) {
118	ctx.resetBounds(startPos, endPos);
119	}
120
121	}
122
123	}

Added Link Here

(-)indent/test/build.xml (+54 lines)
1	<?xml version="1.0"?>
2	<!--
3	The contents of this file are subject to the terms of the Common Development
4	and Distribution License (the License). You may not use this file except in
5	compliance with the License.
6
7	You can obtain a copy of the License at http://www.netbeans.org/cddl.html
8	or http://www.netbeans.org/cddl.txt.
9
10	When distributing Covered Code, include this CDDL Header Notice in each file
11	and include the License file at http://www.netbeans.org/cddl.txt.
12	If applicable, add the following below the CDDL Header, with the fields
13	enclosed by brackets [] replaced by your own identifying information:
14	"Portions Copyrighted [year] [name of copyright owner]"
15
16	The Original Software is NetBeans. The Initial Developer of the Original
17	Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
18	Microsystems, Inc. All Rights Reserved.
19	-->
20	<project name="editor/indent test build script" basedir="." default="all">
21
22	<!-- Name of tested module -->
23	<property name="xtest.module" value="editor/indent"/>
24
25	<!-- Imports buildtests, cleantests, runtest, cleanresults, realclean, printconfig targets. -->
26	<import file="../../../nbbuild/templates/xtest.xml"/>
27	<import file="../../../nbbuild/templates/xtest-unit.xml"/>
28
29	<!-- default testtypes, attributes used when no value is supplied from command line -->
30	<property name="xtest.testtype" value="unit"/>
31	<property name="xtest.attribs" value="stable"/>
32
33	<!-- Build lexer tests -->
34	<target name="build-lexer-tests">
35	<!-- Cannot use
36	<ant dir="../../openide/text/test" target="buildtests" inheritall="false"/>
37	because inheritAll="false" doesn't work for all properties. -->
38	<java classname="org.apache.tools.ant.Main" classpath="${java.class.path}" fork="true">
39	<arg value="-f"/>
40	<arg value="../../../lexer/test/build.xml"/>
41	<arg value="-Dxtest.testtype=unit"/>
42	<arg value="-Dxtest.attribs=stable"/>
43	<arg value="buildtests"/>
44	</java>
45	</target>
46
47	<target name="default-compiler" depends="build-lexer-tests,xtest-unit.default-compiler"/>
48
49	<target name="run-unit-test-noJIT">
50	<antcall target="run-unit-test">
51	<param name="xtest.jvm.args" value="-Xint" />
52	</antcall>
53	</target>
54	</project>

Added Link Here

(-)indent/test/cfg-unit.xml (+62 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!DOCTYPE mconfig PUBLIC "-//NetBeans//DTD XTest cfg 1.0//EN" "http://www.netbeans.org/dtds/xtest-cfg-1_0.dtd">
3	<!--
4	The contents of this file are subject to the terms of the Common Development
5	and Distribution License (the License). You may not use this file except in
6	compliance with the License.
7
8	You can obtain a copy of the License at http://www.netbeans.org/cddl.html
9	or http://www.netbeans.org/cddl.txt.
10
11	When distributing Covered Code, include this CDDL Header Notice in each file
12	and include the License file at http://www.netbeans.org/cddl.txt.
13	If applicable, add the following below the CDDL Header, with the fields
14	enclosed by brackets [] replaced by your own identifying information:
15	"Portions Copyrighted [year] [name of copyright owner]"
16
17	The Original Software is NetBeans. The Initial Developer of the Original
18	Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
19	Microsystems, Inc. All Rights Reserved.
20	-->
21
22	<!--
23	These classes are excluded by default (defined in build.xml):
24	"*/Suite.class"
25	"*/$$*.class"
26	"/data/"
27	"/hidden/"
28	"*/Hidden.*"
29	"*/Hid.*"
30	-->
31
32	<mconfig name="editor/indent unit test config">
33
34	<testbag testattribs="stable" executor="code" name="testbag_1">
35	<testset dir="unit/src">
36	<patternset>
37	<include name="/Test.class"/>
38	<exclude name="org/netbeans/spi/editor/highlighting/performance/**"/>
39	</patternset>
40	</testset>
41	</testbag>
42
43	<testbag testattribs="failing" executor="code" name="testbag_2">
44	<testset dir="unit/src">
45	<patternset>
46	</patternset>
47	</testset>
48	</testbag>
49
50	<!-- If you want to use this testbag you must provide xtest.includes property, -->
51	<!-- (either on cmd line or in the script) to explicitly define which test -->
52	<!-- you want to run. This will run only tests from unit/src folder !!! -->
53	<testbag testattribs="empty" executor="code" name="testbag_empty">
54	<testset dir="unit/src"/>
55	</testbag>
56
57	<executor name="code" antfile="build.xml" target="run-unit-test" default="true"/>
58	<executor name="code-noJIT" antfile="build.xml" target="run-unit-test-noJIT" />
59
60	<compiler name="unit-compiler" antfile="build.xml" target="default-compiler" default="true"/>
61
62	</mconfig>

Added Link Here

(-)indent/test/unit/src/org/netbeans/api/editor/indent/IndentTest.java (+118 lines)
1	/*
2	* The contents of this file are subject to the terms of the Common Development
3	* and Distribution License (the License). You may not use this file except in
4	* compliance with the License.
5	*
6	* You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7	* or http://www.netbeans.org/cddl.txt.
8	*
9	* When distributing Covered Code, include this CDDL Header Notice in each file
10	* and include the License file at http://www.netbeans.org/cddl.txt.
11	* If applicable, add the following below the CDDL Header, with the fields
12	* enclosed by brackets [] replaced by your own identifying information:
13	* "Portions Copyrighted [year] [name of copyright owner]"
14	*
15	* The Original Software is NetBeans. The Initial Developer of the Original
16	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17	* Microsystems, Inc. All Rights Reserved.
18	*/
19
20	package org.netbeans.api.editor.indent;
21
22	import javax.swing.text.BadLocationException;
23	import javax.swing.text.Document;
24	import javax.swing.text.PlainDocument;
25	import org.netbeans.junit.NbTestCase;
26	import org.netbeans.modules.editor.indent.IndentTestMimeDataProvider;
27	import org.netbeans.spi.editor.indent.Context;
28	import org.netbeans.spi.editor.indent.ExtraLock;
29	import org.netbeans.spi.editor.indent.IndentTask;
30
31	/**
32	*
33	* @author Miloslav Metelka
34	*/
35	public class IndentTest extends NbTestCase {
36
37	private static final String MIME_TYPE = "text/x-test";
38
39	public IndentTest(String name) {
40	super(name);
41	}
42
43	public void testFindIndentTaskFactory() throws BadLocationException {
44	TestIndentTask.TestFactory factory = new TestIndentTask.TestFactory();
45	IndentTestMimeDataProvider.addInstances(MIME_TYPE, factory);
46	Document doc = new PlainDocument();
47	doc.putProperty("mimeType", MIME_TYPE);
48	Indent indent = Indent.get(doc);
49	indent.lock();
50	try {
51	//doc.atomicLock();
52	try {
53	indent.reindent(0);
54	} finally {
55	//doc.atomicUnlock();
56	}
57	} finally {
58	indent.unlock();
59	}
60	// Check that the factory was used
61	assertTrue(factory.lastCreatedTask.indentPerformed);
62	}
63
64	private static final class TestIndentTask implements IndentTask {
65
66	private Context context;
67
68	TestExtraLocking lastCreatedLocking;
69
70	boolean indentPerformed;
71
72	TestIndentTask(Context context) {
73	this.context = context;
74	}
75
76	public void reindent() throws BadLocationException {
77	assertTrue(lastCreatedLocking.locked);
78	context.document().insertString(0, " ", null);
79	indentPerformed = true;
80	}
81
82	public ExtraLock indentLock() {
83	return (lastCreatedLocking = new TestExtraLocking());
84	}
85
86	static final class TestFactory implements IndentTask.Factory {
87
88	static TestIndentTask lastCreatedTask;
89
90	public IndentTask createTask(Context context) {
91	return (lastCreatedTask = new TestIndentTask(context));
92	}
93
94	}
95
96	}
97
98	private static final class TestExtraLocking implements ExtraLock {
99
100	Boolean locked;
101
102	public Boolean locked() {
103	return locked;
104	}
105
106	public void lock() {
107	if (locked != null)
108	assertFalse(locked);
109	locked = true;
110	}
111
112	public void unlock() {
113	assertTrue(locked);
114	locked = false;
115	}
116
117	}
118	}

Added Link Here

(-)indent/test/unit/src/org/netbeans/modules/editor/indent/IndentActionsTest.java (+146 lines)
1	/*
2	* The contents of this file are subject to the terms of the Common Development
3	* and Distribution License (the License). You may not use this file except in
4	* compliance with the License.
5	*
6	* You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7	* or http://www.netbeans.org/cddl.txt.
8	*
9	* When distributing Covered Code, include this CDDL Header Notice in each file
10	* and include the License file at http://www.netbeans.org/cddl.txt.
11	* If applicable, add the following below the CDDL Header, with the fields
12	* enclosed by brackets [] replaced by your own identifying information:
13	* "Portions Copyrighted [year] [name of copyright owner]"
14	*
15	* The Original Software is NetBeans. The Initial Developer of the Original
16	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17	* Microsystems, Inc. All Rights Reserved.
18	*/
19
20	package org.netbeans.modules.editor.indent;
21
22	import java.awt.event.ActionEvent;
23	import javax.swing.Action;
24	import javax.swing.JEditorPane;
25	import javax.swing.SwingUtilities;
26	import org.netbeans.api.editor.indent.*;
27	import javax.swing.text.BadLocationException;
28	import org.netbeans.editor.BaseKit;
29	import org.netbeans.junit.NbTestCase;
30	import org.netbeans.modules.editor.NbEditorKit;
31	import org.netbeans.modules.editor.indent.IndentTestMimeDataProvider;
32	import org.netbeans.spi.editor.indent.Context;
33	import org.netbeans.spi.editor.indent.ExtraLock;
34	import org.netbeans.spi.editor.indent.IndentTask;
35
36	/**
37	*
38	* @author Miloslav Metelka
39	*/
40	public class IndentActionsTest extends NbTestCase {
41
42	private static final String MIME_TYPE = "text/x-test-actions";
43
44	public IndentActionsTest(String name) {
45	super(name);
46	}
47
48	public void testIndentActions() {
49	// Must run in AWT thread (BaseKit.install() checks for that)
50	if (!SwingUtilities.isEventDispatchThread()) {
51	SwingUtilities.invokeLater(
52	new Runnable() {
53	public void run() {
54	testIndentActions();
55	}
56	}
57	);
58	return;
59	}
60
61	assertTrue(SwingUtilities.isEventDispatchThread());
62	TestIndentTask.TestFactory factory = new TestIndentTask.TestFactory();
63	IndentTestMimeDataProvider.addInstances(MIME_TYPE, factory);
64	TestKit kit = new TestKit();
65	JEditorPane pane = new JEditorPane();
66	pane.setEditorKit(kit);
67	assertEquals(MIME_TYPE, pane.getDocument().getProperty("mimeType"));
68	//doc.putProperty("mimeType", MIME_TYPE);
69
70	// Test insert new line action
71	Action a = kit.getActionByName(BaseKit.insertBreakAction);
72	assertNotNull(a);
73	a.actionPerformed(new ActionEvent(pane, 0, ""));
74	// Check that the factory was used
75	assertTrue(factory.lastCreatedTask.indentPerformed);
76
77	// Test reformat action
78	a = kit.getActionByName(BaseKit.formatAction);
79	assertNotNull(a);
80	a.actionPerformed(new ActionEvent(pane, 0, ""));
81
82	}
83
84	private static final class TestIndentTask implements IndentTask {
85
86	private Context context;
87
88	TestExtraLocking lastCreatedLocking;
89
90	boolean indentPerformed;
91
92	TestIndentTask(Context context) {
93	this.context = context;
94	}
95
96	public void reindent() throws BadLocationException {
97	assertTrue(lastCreatedLocking.locked);
98	context.document().insertString(0, " ", null);
99	indentPerformed = true;
100	}
101
102	public ExtraLock indentLock() {
103	return (lastCreatedLocking = new TestExtraLocking());
104	}
105
106	static final class TestFactory implements IndentTask.Factory {
107
108	static TestIndentTask lastCreatedTask;
109
110	public IndentTask createTask(Context context) {
111	return (lastCreatedTask = new TestIndentTask(context));
112	}
113
114	}
115
116	}
117
118	private static final class TestExtraLocking implements ExtraLock {
119
120	Boolean locked;
121
122	public Boolean locked() {
123	return locked;
124	}
125
126	public void lock() {
127	if (locked != null)
128	assertFalse(locked);
129	locked = true;
130	}
131
132	public void unlock() {
133	assertTrue(locked);
134	locked = false;
135	}
136
137	}
138
139	private static final class TestKit extends NbEditorKit {
140
141	public String getContentType() {
142	return MIME_TYPE;
143	}
144
145	}
146	}

Added Link Here

(-)libsrc/org/netbeans/modules/editor/lib/FormatterOverride.java (+44 lines)
1	/*
2	* The contents of this file are subject to the terms of the Common Development
3	* and Distribution License (the License). You may not use this file except in
4	* compliance with the License.
5	*
6	* You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7	* or http://www.netbeans.org/cddl.txt.
8	*
9	* When distributing Covered Code, include this CDDL Header Notice in each file
10	* and include the License file at http://www.netbeans.org/cddl.txt.
11	* If applicable, add the following below the CDDL Header, with the fields
12	* enclosed by brackets [] replaced by your own identifying information:
13	* "Portions Copyrighted [year] [name of copyright owner]"
14	*
15	* The Original Software is NetBeans. The Initial Developer of the Original
16	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17	* Microsystems, Inc. All Rights Reserved.
18	*/
19
20	package org.netbeans.modules.editor.lib;
21
22	import javax.swing.text.Document;
23	import org.netbeans.editor.Formatter;
24
25	/**
26	* Class to be searched in lookup that can override a formatter for the given document.
27	* <br/>
28	* It is a private contract between editor/lib and editor/indent.
29	*
30	* @author Miloslav Metelka
31	*/
32	public interface FormatterOverride {
33
34	/**
35	* Possibly override the default formatter used for the given document.
36	*
37	* @param doc non-null document for which the formatter is being searched.
38	* @param defaultFormatter default formatter found by the infrastructure
39	* or null if there is none.
40	* @return overriden formatter or the default formatter passed as the argument.
41	*/
42	Formatter getFormatter(Document doc, Formatter defaultFormatter);
43
44	}

Added Link Here

(-)src/org/netbeans/modules/editor/NbEditorDocument.java (+394 lines)
1	/*
2	* The contents of this file are subject to the terms of the Common Development
3	* and Distribution License (the License). You may not use this file except in
4	* compliance with the License.
5	*
6	* You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7	* or http://www.netbeans.org/cddl.txt.
8	*
9	* When distributing Covered Code, include this CDDL Header Notice in each file
10	* and include the License file at http://www.netbeans.org/cddl.txt.
11	* If applicable, add the following below the CDDL Header, with the fields
12	* enclosed by brackets [] replaced by your own identifying information:
13	* "Portions Copyrighted [year] [name of copyright owner]"
14	*
15	* The Original Software is NetBeans. The Initial Developer of the Original
16	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17	* Microsystems, Inc. All Rights Reserved.
18	*/
19
20	package org.netbeans.modules.editor;
21
22	import java.awt.Font;
23	import java.awt.Color;
24	import java.awt.Component;
25	import java.util.ArrayList;
26	import java.util.HashMap;
27	import java.text.AttributedCharacterIterator;
28	import javax.swing.text.AttributeSet;
29	import javax.swing.JEditorPane;
30	import org.netbeans.editor.BaseKit;
31	import org.netbeans.editor.GuardedDocument;
32	import org.netbeans.editor.PrintContainer;
33	import org.netbeans.editor.Formatter;
34	import org.netbeans.editor.Settings;
35	import org.netbeans.editor.SettingsChangeEvent;
36	import org.netbeans.editor.Utilities;
37	import org.openide.text.NbDocument;
38	import org.openide.text.AttributedCharacters;
39	import javax.swing.text.Position;
40	import org.openide.text.Annotation;
41	import java.beans.PropertyChangeListener;
42	import java.beans.PropertyChangeEvent;
43	import java.util.Dictionary;
44	import java.util.Map;
45	import java.util.WeakHashMap;
46	import javax.swing.JToolBar;
47	import javax.swing.event.ChangeEvent;
48	import javax.swing.event.ChangeListener;
49	import org.netbeans.editor.BaseDocument;
50	import javax.swing.text.BadLocationException;
51	import javax.swing.text.Document;
52	import org.netbeans.editor.AnnotationDesc;
53
54	/**
55	* BaseDocument extension managing the readonly blocks of text
56	*
57	* @author Miloslav Metelka
58	* @version 1.00
59	*/
60
61	public class NbEditorDocument extends GuardedDocument
62	implements NbDocument.PositionBiasable, NbDocument.WriteLockable,
63	NbDocument.Printable, NbDocument.CustomEditor, NbDocument.CustomToolbar, NbDocument.Annotatable {
64
65	/** Name of the formatter setting. */
66	public static final String FORMATTER = "formatter"; // NOI18N
67
68	/** Mime type of the document. The name of this property corresponds
69	* to the property that is filled in the document by CloneableEditorSupport.
70	*/
71	public static final String MIME_TYPE_PROP = "mimeType"; // NOI18N
72
73	/** Indent engine for the given kitClass. */
74	public static final String INDENT_ENGINE = "indentEngine"; // NOI18N
75
76	/** Formatter being used. */
77	private Formatter formatter;
78
79	/** Map of [Annotation, AnnotationDesc] */
80	private HashMap annoMap;
81
82	// #39718 hotfix
83	private WeakHashMap annoBlackList;
84
85	public NbEditorDocument(Class kitClass) {
86	super(kitClass);
87	addStyleToLayerMapping(NbDocument.BREAKPOINT_STYLE_NAME,
88	NbDocument.BREAKPOINT_STYLE_NAME + "Layer:10"); // NOI18N
89	addStyleToLayerMapping(NbDocument.ERROR_STYLE_NAME,
90	NbDocument.ERROR_STYLE_NAME + "Layer:20"); // NOI18N
91	addStyleToLayerMapping(NbDocument.CURRENT_STYLE_NAME,
92	NbDocument.CURRENT_STYLE_NAME + "Layer:30"); // NOI18N
93	setNormalStyleName(NbDocument.NORMAL_STYLE_NAME);
94
95	annoMap = new HashMap(20);
96	annoBlackList = new WeakHashMap();
97	}
98
99	public void settingsChange(SettingsChangeEvent evt) {
100	super.settingsChange(evt);
101
102	// Check whether the mimeType is set
103	Object o = getProperty(MIME_TYPE_PROP);
104	if (!(o instanceof String)) {
105	BaseKit kit = BaseKit.getKit(getKitClass());
106	putProperty(MIME_TYPE_PROP, kit.getContentType());
107	}
108
109	// Fill in the indentEngine property
110	putProperty(INDENT_ENGINE,
111	new BaseDocument.PropertyEvaluator() {
112
113	private Object cached;
114
115	public Object getValue() {
116	if (cached == null) {
117	cached = Settings.getValue(getKitClass(), INDENT_ENGINE);
118	}
119
120	return cached;
121	}
122	}
123	);
124
125	// Refresh formatter
126	formatter = null;
127
128	}
129
130	public void setCharacterAttributes(int offset, int length, AttributeSet s,
131	boolean replace) {
132	if (s != null) {
133	Object val = s.getAttribute(NbDocument.GUARDED);
134	if (val != null && val instanceof Boolean) {
135	if (((Boolean)val).booleanValue() == true) { // want make guarded
136	super.setCharacterAttributes(offset, length, guardedSet, replace);
137	} else { // want make unguarded
138	super.setCharacterAttributes(offset, length, unguardedSet, replace);
139	}
140	} else { // not special values, just pass
141	super.setCharacterAttributes(offset, length, s, replace);
142	}
143	}
144	}
145
146	public java.text.AttributedCharacterIterator[] createPrintIterators() {
147	NbPrintContainer npc = new NbPrintContainer();
148	print(npc);
149	return npc.getIterators();
150	}
151
152	public Component createEditor(JEditorPane j) {
153	return Utilities.getEditorUI(j).getExtComponent();
154	}
155
156	public JToolBar createToolbar(JEditorPane j) {
157	return Utilities.getEditorUI(j).getToolBarComponent();
158	}
159
160	public Formatter getFormatter() {
161	Formatter f = formatter;
162	if (f == null) {
163	formatter = (Formatter)Settings.getValue(getKitClass(), FORMATTER);
164	f = formatter;
165	}
166	putProperty("defaultFormatter", f);
167	// The super implementation will inspect "defaultFormatter" property
168	return super.getFormatter();
169	}
170
171	/** Add annotation to the document. For annotation of whole line
172	* the length parameter can be ignored (specify value -1).
173	* @param startPos position which represent begining
174	* of the annotated text
175	* @param length length of the annotated text. If -1 is specified
176	* the whole line will be annotated
177	* @param annotation annotation which is attached to this text */
178	public void addAnnotation(Position startPos, int length, Annotation annotation) {
179	Integer count = (Integer)annoBlackList.get(annotation);
180	if (count != null) {
181	// #39718 hotfix - test whether the annotation was already removed; if so, just remove it from the black list and return
182	if (count.intValue() == -1) {
183	annoBlackList.remove(annotation);
184	return;
185	} else if (count.intValue() < -1) {
186	annoBlackList.put(annotation, new Integer(count.intValue() + 1));
187	return;
188	}
189	}
190	// partial fix of #33165 - read-locking of the document added
191	// BTW should only be invoked in EQ - see NbDocument.addAnnotation()
192	readLock();
193	try {
194	// Recreate annotation's position to make sure it's in this doc at a valid offset
195	int docLen = getLength();
196	int offset = startPos.getOffset();
197	offset = Math.min(offset, docLen);
198	try {
199	startPos = createPosition(offset);
200	} catch (BadLocationException e) {
201	startPos = null; // should never happen
202	}
203
204	AnnotationDescDelegate a = (AnnotationDescDelegate)annoMap.get(annotation);
205	if (a != null) { // already added before
206	// #39718 hotfix - remove the original annotation descriptor and put the annotation on the black list
207	a.detachListeners();
208	getAnnotations().removeAnnotation(a);
209	annoMap.remove(annotation);
210	annoBlackList.put(annotation, new Integer(count != null ? count.intValue() + 1 : 1));
211	}
212	if (annotation.getAnnotationType() != null) {
213	a = new AnnotationDescDelegate(this, startPos, length, annotation);
214	annoMap.put(annotation, a);
215	getAnnotations().addAnnotation(a);
216	}
217	} finally {
218	readUnlock();
219	}
220	}
221
222	/** Removal of added annotation.
223	* @param annotation annotation which is going to be removed */
224	public void removeAnnotation(Annotation annotation) {
225	if (annotation == null) { // issue 14803
226	return; // can't do more as the rest of stacktrace is in openide and ant
227	}
228
229	Integer count = (Integer)annoBlackList.get(annotation);
230	if (count != null) {
231	// #39718 hotfix - test whether the annotation was already removed; if so, just remove it from the black list and return
232	if (count.intValue() == 1) {
233	annoBlackList.remove(annotation);
234	return;
235	} else if (count.intValue() > 1) {
236	annoBlackList.put(annotation, new Integer(count.intValue() - 1));
237	return;
238	}
239	}
240	// partial fix of #33165 - read-locking of the document added
241	// BTW should only be invoked in EQ - see NbDocument.removeAnnotation()
242	readLock();
243	try {
244	if (annotation.getAnnotationType() != null) {
245	AnnotationDescDelegate a = (AnnotationDescDelegate)annoMap.get(annotation);
246	if (a == null) { // not added yet
247	// #39718 hotfix - put the annotation on the black list and return
248	annoBlackList.put(annotation, new Integer(count != null ? count.intValue() - 1 : -1));
249	return;
250	}
251	a.detachListeners();
252	getAnnotations().removeAnnotation(a);
253	annoMap.remove(annotation);
254	}
255	} finally {
256	readUnlock();
257	}
258	}
259
260	Map getAnnoMap(){
261	return annoMap;
262	}
263
264	void addStreamDescriptionChangeListener(ChangeListener l) {
265	listenerList.add(ChangeListener.class, l);
266	}
267
268	void removeStreamDescriptionChangeListener(ChangeListener l) {
269	listenerList.remove(ChangeListener.class, l);
270	}
271
272	private void fireStreamDescriptionChange() {
273	ChangeEvent evt = new ChangeEvent(this);
274	Object[] listeners = listenerList.getListenerList();
275	for (int i = listeners.length - 2; i >= 0; i -= 2) {
276	if (listeners[i] == ChangeListener.class) {
277	((ChangeListener)listeners[i + 1]).stateChanged(evt);
278	}
279	}
280	}
281
282	protected Dictionary createDocumentProperties(Dictionary origDocumentProperties) {
283	return new LazyPropertyMap(origDocumentProperties) {
284	public Object put(Object key, Object value) {
285	Object origValue = super.put(key, value);
286	if (Document.StreamDescriptionProperty.equals(key)) {
287	if (origValue == null \|\| !origValue.equals(value)) {
288	fireStreamDescriptionChange();
289	}
290	}
291
292	return origValue;
293	}
294	};
295	}
296
297	/** Implementation of AnnotationDesc, which delegate to Annotation instance
298	* defined in org.openide.text package.
299	*/
300	static class AnnotationDescDelegate extends AnnotationDesc {
301
302	private Annotation delegate;
303	private PropertyChangeListener l;
304	private Position pos;
305	private BaseDocument doc;
306
307	AnnotationDescDelegate(BaseDocument doc, Position pos, int length, Annotation anno) {
308	super(pos.getOffset(),length);
309	this.pos = pos;
310	this.delegate = anno;
311	this.doc = doc;
312
313	// update AnnotationDesc.type member
314	updateAnnotationType();
315
316	// forward property changes to AnnotationDesc property changes
317	l = new PropertyChangeListener() {
318	public void propertyChange (PropertyChangeEvent evt) {
319	if (evt.getPropertyName() == Annotation.PROP_SHORT_DESCRIPTION)
320	firePropertyChange(AnnotationDesc.PROP_SHORT_DESCRIPTION, null, null);
321	if (evt.getPropertyName() == Annotation.PROP_MOVE_TO_FRONT)
322	firePropertyChange(AnnotationDesc.PROP_MOVE_TO_FRONT, null, null);
323	if (evt.getPropertyName() == Annotation.PROP_ANNOTATION_TYPE) {
324	updateAnnotationType();
325	firePropertyChange(AnnotationDesc.PROP_ANNOTATION_TYPE, null, null);
326	}
327	}
328	};
329	delegate.addPropertyChangeListener(l);
330	}
331
332	public String getAnnotationType() {
333	return delegate.getAnnotationType();
334	}
335
336	public String getShortDescription() {
337	return delegate.getShortDescription();
338	}
339
340	void detachListeners() {
341	delegate.removePropertyChangeListener(l);
342	}
343
344	public int getOffset() {
345	return pos.getOffset();
346	}
347
348	public int getLine() {
349	try {
350	return Utilities.getLineOffset(doc, pos.getOffset());
351	} catch (BadLocationException e) {
352	return 0;
353	}
354	}
355
356	}
357
358
359	class NbPrintContainer extends AttributedCharacters implements PrintContainer {
360
361	ArrayList acl = new ArrayList();
362
363	AttributedCharacters a;
364
365	NbPrintContainer() {
366	a = new AttributedCharacters();
367	}
368
369	public void add(char[] chars, Font font, Color foreColor, Color backColor) {
370	a.append(chars, font, foreColor);
371	}
372
373	public void eol() {
374	acl.add(a);
375	a = new AttributedCharacters();
376	}
377
378	public boolean initEmptyLines() {
379	return true;
380	}
381
382	public AttributedCharacterIterator[] getIterators() {
383	int cnt = acl.size();
384	AttributedCharacterIterator[] acis = new AttributedCharacterIterator[cnt];
385	for (int i = 0; i < cnt; i++) {
386	AttributedCharacters ac = (AttributedCharacters)acl.get(i);
387	acis[i] = ac.iterator();
388	}
389	return acis;
390	}
391
392	}
393
394	}