001: /* ====================================================================
002: * The JRefactory License, Version 1.0
003: *
004: * Copyright (c) 2001 JRefactory. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by the
021: * JRefactory (http://www.sourceforge.org/projects/jrefactory)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. The names "JRefactory" must not be used to endorse or promote
026: * products derived from this software without prior written
027: * permission. For written permission, please contact seguin@acm.org.
028: *
029: * 5. Products derived from this software may not be called "JRefactory",
030: * nor may "JRefactory" appear in their name, without prior written
031: * permission of Chris Seguin.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE CHRIS SEGUIN OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of JRefactory. For more information on
049: * JRefactory, please see
050: * <http://www.sourceforge.org/projects/jrefactory>.
051: */
052: package org.acm.seguin.ide.kawa;
053:
054: import java.util.Properties;
055: import java.util.Enumeration;
056: import org.acm.seguin.pretty.*;
057: import com.allaire.kawa.plugin.*;
058: import org.acm.seguin.util.FileSettings;
059:
060: /**
061: * This plugin is for Kawa 5 and will not work on previous versions though it
062: * will be fairly easy to port. I decided to write this plugin since I used to
063: * write my code in Kawa and then reopen it with the slow java editor jEdit
064: * just to add code comments. So one night I spend some minutes in creating
065: * this simple plugin and now I have pretty print feature in my Kawa - thanks
066: * to folks who created jrefactory (http://jrefactory.sf.net/).<P>
067: *
068: * Instructions for installation:<BR>
069: *
070: * <UL>
071: * <LI> Extract KawaPrettyPrint.jar in <EM>KAWA</EM> \plugin directory.
072: * <LI> From "Customize" menu select "Commands" and then "Plugin Command"
073: *
074: * <LI> Press button "New" and write down "KawaPrettyPrint" for "Menu Name"
075: *
076: * <LI> Set "Main Class" to "org.acm.seguin.ide.kawa.KawaPrettyPrint"
077: * <LI> If you wish KawaPrettyPrint to automaticaly beautify your source on
078: * file save set "Arguments" to "-install" (without quotes)
079: * <LI> Set classpath to the folder where KawaPrettyPrint is installed and to
080: * the file jrefactory.jar located in the same directory.
081: * <LI> If you set "Arguments" to -install you may open Options tab and
082: * select "Execute command when Kawa starts". If you didn't set -install
083: * option then you may wish to select "Add command to right button menu in
084: * editor"
085: * <LI> Enjoy!
086: * </UL>
087: *
088: *
089: *@author Valentin Valchev <v_valchev@prosyst.bg>
090: *@created 16.11.2001
091: *@since 2.6.32
092: */
093: public class KawaPrettyPrint extends PrettyPrintFromIDE implements
094: KawaEventListener {
095: KawaEditor editor = null;
096: static boolean installed = false;
097:
098: /**
099: * Constructor for the KawaPrettyPrint object
100: *
101: *@since 2.6.32
102: *@param install Has this been installed?
103: */
104: public KawaPrettyPrint(boolean install) {
105: if (install && (!installed)) {
106: KawaFile.addListener(this );
107: installed = true;
108: } else {
109: for (Enumeration e = KawaApp.enumerateEditors(); e
110: .hasMoreElements();) {
111: editor = (KawaEditor) e.nextElement();
112: if (editor.hasFocus()) {
113: break;
114: }
115: }
116: synchronized (editor) {
117: try {
118: prettyPrintCurrentWindow();
119: } catch (Throwable t) {
120: }
121: }
122: editor = null;
123: }
124: }
125:
126: /**
127: * This method is called from parent. Unfortunately Kawa does not support
128: * getting current line number and that's why setting current line number
129: * is useless.
130: *
131: *@since 2.6.32
132: *@param value The new line number
133: */
134: protected void setLineNumber(int value) {
135: synchronized (editor) {
136: editor.gotoLine(value, false);
137: }
138: }
139:
140: /**
141: * Again method called from within parent class. When called buffer
142: * contents should be replaced with text contained within <code>value</code>
143: * parameter
144: *
145: *@since 2.6.32
146: *@param value the new contents of current buffer
147: */
148: protected void setStringInIDE(String value) {
149: synchronized (editor) {
150: editor.setSelect(0, -1);
151: editor.paste(value);
152: }
153: }
154:
155: /**
156: * Returns the number of current line - Kawa does not support this - but I
157: * do!! Yes! This works now almost perfectly ;)
158: *
159: *@since 2.6.32
160: *@return current line number
161: */
162: protected int getLineNumber() {
163: synchronized (editor) {
164: String text = editor.getEditorText();
165: try {
166: int line = 1;
167: for (int i = 0; i < editor.getLineIndex(-1); i++) {
168: if (text.charAt(i) == '\n') {
169: line++;
170: }
171: }
172: return (line);
173: } catch (Throwable t) {
174: return (int) (editor.getLineCount() / 2);
175: }
176: }
177: }
178:
179: /**
180: * Called prom parrent class this method should return contents of buffer
181: *
182: *@since 2.6.32
183: *@return contents of file which is going to be saved.
184: */
185: protected String getStringFromIDE() {
186: synchronized (editor) {
187: return editor.getEditorText();
188: }
189: }
190:
191: /**
192: * The main program for the KawaPrettyPrint class
193: *
194: *@since 2.6.32
195: *@param args The command line arguments
196: */
197: public static void main(String[] args) {
198:
199: boolean install = false;
200: if (args != null) {
201: for (int i = 0; i < args.length; i++) {
202: if (args[i].equals("-install")) {
203: install = true;
204: }
205: }
206: }
207:
208: // create and start plugin
209: new KawaPrettyPrint(install);
210: }
211:
212: /**
213: * This method is implementation of KawaEventListener, onEvent(). It is
214: * called by Kawa upon incoming events. KawaEventListener is installed on
215: * KawaFile and this method is called upon KawaFileEvent.
216: *
217: *@since 2.6.32
218: *@param event KawaEvent
219: */
220: public void onEvent(KawaEvent event) {
221: if (event.getID() == KawaFileEvent.FILE_SAVING) {
222: // inform user. (must be done since first loading of plugin takes along time)
223: KawaApp.out.showWindow(true);
224: KawaApp.out.println("Please wait, formatting buffer");
225:
226: // get editor and lock it in synchronized section. This will prevent loss of data.
227: editor = ((KawaFile) event.getSource()).getEditor(false);
228:
229: // don't try to beautify read only files
230: if (editor.isReadOnly()) {
231: editor = null;
232: return;
233: }
234: synchronized (editor) {
235: try {
236: prettyPrintCurrentWindow();
237: } catch (Throwable t) {
238: }
239: }
240: editor = null;
241: }
242: }
243: }
244: // EOF
|