") ? text : "
"+text+"
"; Matcher matcher = Pattern.compile("([A-Z_]{2,}|Warning:|Note:|@[a-z]+)").matcher(text); StringBuffer buffer = new StringBuffer(); while( matcher.find() ) { String match = matcher.group(1); if( match.equals("YES") || match.equals("NO") ) { matcher.appendReplacement( buffer, ""+match+""); } else if( match.equals("Note:") || match.equals("Warning:") ) { matcher.appendReplacement( buffer, ""+match+""); } else if( match.startsWith("@") ) { matcher.appendReplacement( buffer, ""+match+""); } else { Setting matchSetting = doxyfile.getSetting(match); if( matchSetting != null ) { String settingText = matchSetting.getProperty(Setting.TEXT); if( matchSetting == setting ) { matcher.appendReplacement( buffer, ""+settingText+""); } else { matcher.appendReplacement( buffer, ""+settingText+""); } } } } matcher.appendTail( buffer ); text = buffer.toString(); } // Finally, assignes the text to the user interface control. this.noteLabel.setText("", true, false); } } eclox/eclox.ui/src/eclox/ui/editor/advanced/filters/ 0000755 0001750 0000144 00000000000 12315037715 022022 5 ustar willy users eclox/eclox.ui/src/eclox/ui/editor/advanced/filters/Modified.java 0000644 0001750 0000144 00000012274 12166012446 024411 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2005, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced.filters; import java.util.Iterator; import org.eclipse.jface.viewers.StructuredViewer; import org.eclipse.jface.viewers.Viewer; import org.eclipse.jface.viewers.ViewerFilter; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.IManagedForm; import eclox.core.doxyfiles.Doxyfile; import eclox.core.doxyfiles.ISettingPropertyListener; import eclox.core.doxyfiles.Setting; import eclox.ui.editor.Editor; /** * Implements a filter that will shows only modified settings * (setting having the dirty flag). * * @author gbrocker */ public class Modified implements IFilter { /** * The structured viewer to filter. */ private StructuredViewer viewer; /** * the viewer filter installed in the managed viewer */ private MyViewerFiler viewerFilter; /** * the setting property listener instance */ private MySettingPropertyListener settingPropertyListener; /** * Implements a viewer filter that will only show * setting having the dirty property. */ private class MyViewerFiler extends ViewerFilter { public boolean select(Viewer viewer, Object parentElement, Object element) { // Pre-condition assert element instanceof Setting; Setting setting = (Setting) element; return setting.hasProperty( Editor.PROP_SETTING_DIRTY ); } public boolean isFilterProperty(Object element, String property) { if( element instanceof Setting ) { return property.equals( Editor.PROP_SETTING_DIRTY ); } else { return super.isFilterProperty(element, property); } } } /** * Implements a setting property listener that will trigger * the viewer refresh as soon as a setting dirty property changed. */ private class MySettingPropertyListener implements ISettingPropertyListener { /** * the doxyfile being listened */ private Doxyfile doxyfile; /** * Attaches the listener to the specified doxyfile. Before being * destroyed, the listener should be explicitely detached. * * @param doxyfile a doxyfile the listener will attach to * * @see detach */ public void attach( Doxyfile doxyfile ) { // Pre-condition assert this.doxyfile == null; // References the doxyfile for later use. this.doxyfile = doxyfile; // Attaches to all settings. Iterator i = doxyfile.settingIterator(); while( i.hasNext() ) { Setting setting = (Setting) i.next(); setting.addSettingListener( this ); } // Post-condition assert this.doxyfile != null; } /** * Detaches the listener from the previously attached doxyfile. * * @see attach */ public void detach() { // Pre-condition assert this.doxyfile != null; // Detaches the listener instace from all settings Iterator i = this.doxyfile.settingIterator(); while( i.hasNext() ) { Setting setting = (Setting) i.next(); setting.removeSettingListener( this ); } // Unreferences the managed doxyfile. this.doxyfile = null; // Post-condition assert this.doxyfile == null; } public void settingPropertyChanged(Setting setting, String property) { // Pre-condition assert viewer != null; viewer.update( setting, new String[]{Editor.PROP_SETTING_DIRTY} ); } public void settingPropertyRemoved(Setting setting, String property) { // Pre-condition assert viewer != null; viewer.update( setting, new String[]{Editor.PROP_SETTING_DIRTY} ); } } public void setDoxyfile(Doxyfile doxyfile) { if( doxyfile != null ) { this.settingPropertyListener = new MySettingPropertyListener(); this.settingPropertyListener.attach( doxyfile ); } else { this.settingPropertyListener.detach(); this.settingPropertyListener = null; } } public void createControls(IManagedForm managedForm, Composite parent) { // Nothing to do. } public void createViewerFilters(StructuredViewer viewer) { // Pre-condition assert this.viewer == null; assert this.viewerFilter == null; // Create relevant object instances. this.viewer = viewer; this.viewerFilter = new MyViewerFiler(); this.viewer.addFilter( this.viewerFilter ); // Post-condition assert this.viewer != null; assert this.viewerFilter != null; } public void disposeControls() { // Nothing to do. } public void disposeViewerFilers(StructuredViewer viewer) { // Pre-condition assert this.viewer != null; assert this.viewerFilter != null; // Remove references on out-dated objects. this.viewer.removeFilter( this.viewerFilter ); this.viewerFilter = null; this.viewer = null; // Post-condition assert this.viewer == null; assert this.viewerFilter == null; } public String getName() { return "Modified"; } } eclox/eclox.ui/src/eclox/ui/editor/advanced/filters/Custom.java 0000644 0001750 0000144 00000021750 12166012446 024142 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2005, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced.filters; import org.eclipse.jface.viewers.StructuredViewer; import org.eclipse.jface.viewers.Viewer; import org.eclipse.jface.viewers.ViewerFilter; import org.eclipse.swt.SWT; import org.eclipse.swt.events.ModifyEvent; import org.eclipse.swt.events.ModifyListener; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.graphics.Point; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Combo; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.IManagedForm; import eclox.core.doxyfiles.Doxyfile; import eclox.core.doxyfiles.Setting; import eclox.ui.Images; import eclox.ui.Plugin; public class Custom implements IFilter { /** * the combo box containing the text used for the setting filtering */ private Combo combo; /** * the clear button */ private Button clearButton; /** * an array of strings containing the saved combo items */ private String[] savedComboItems = null; /** * a string containing the saved combo text */ private String savedComboText = new String(); /** * a string containing the text to use for filtering */ private String filterText; /** * the viewer being filtered */ private StructuredViewer viewer; /** * the viewer filter currently installed in the viewer to filter */ private MyViewerFiler viewerFilter; /** * Implements a timer task that will trigger the viewer refresh after * the user changed the custom filter text and update the items available * in the filter combo control. */ private class MyRunnable implements Runnable { private String referenceText; public MyRunnable( String referenceText ) { this.referenceText = new String( referenceText ); } public void run() { // Pre-condition assert combo != null; assert viewer != null; // Retrieves the combo text and checks that the user has not entered additionnal text. String comboText = combo.getText(); if( comboText.equalsIgnoreCase(referenceText) == false ) { return; } if( comboText.length() == 0 ) { combo.select( -1 ); } else { // Scans combo text items for the combo text. String comboItems[] = combo.getItems(); boolean found = false; for( int i = 0; i < comboItems.length; ++i ) { if( comboItems[i].equalsIgnoreCase(comboText) == true ) { found = true; break; } } if( found == false ) { combo.add( comboText, 0 ); } } // Refreshes the combo so the elements will be refiltered. viewer.refresh(); } }; /** * Implements a viewer filter that will search for setting matching the * string entered by the user in the combo control. */ private class MyViewerFiler extends ViewerFilter { /** * @see org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object) */ public boolean select(Viewer viewer, Object parentElement, Object element) { // Pre-condition assert element instanceof Setting; // Tests if the current setting matches the query string. if( filterText != null ) { Setting setting = (Setting) element; final String settingText = setting.getProperty(Setting.TEXT); return ( settingText != null ) && ( settingText.toLowerCase().indexOf(filterText.toLowerCase()) != -1 ); } else { return true; } } }; /** * Implements a combo modification listener that will trigger * the viewer refresh. */ private class MyComboModifyListener implements ModifyListener { public void modifyText(ModifyEvent e) { // Pre-condition assert combo != null; filterText = new String( combo.getText() ); combo.getDisplay().timerExec( 450, new MyRunnable(filterText) ); } }; /** * Implements a selection listsner for the managed clear button. */ private class MyClearSelectionListener implements SelectionListener { public void widgetDefaultSelected(SelectionEvent e) { // Pre-condition assert combo != null; // Clears the managed combo text. combo.select( -1 ); combo.setText( new String() ); } public void widgetSelected(SelectionEvent e) { // Pre-condition assert combo != null; // Clears the managed combo text. combo.select( -1 ); combo.setText( new String() ); } } /** * @see eclox.ui.editor.advanced.filters.IFilter#createControls(org.eclipse.ui.forms.IManagedForm, org.eclipse.swt.widgets.Composite) */ public void createControls(IManagedForm managedForm, Composite parent) { // Pre-condition assert combo == null; assert clearButton == null; // Creates the combo control allowing the user to enter text to search. combo = new Combo( parent, SWT.FLAT|SWT.BORDER ); // Fills the combo with the eventual saved items. if( this.savedComboItems != null ) { combo.setItems( this.savedComboItems ); } else { combo.setText("type filter text"); } // Restores the saved combo selected item. combo.setText( this.savedComboText ); combo.setSelection( new Point(0,combo.getText().length()) ); // Attaches a modify listener. combo.addModifyListener( new MyComboModifyListener() ); // Creates the clear button. clearButton = managedForm.getToolkit().createButton( parent, null, SWT.FLAT ); clearButton.setImage( Plugin.getImageDescriptor( Images.ERASE ).createImage() ); clearButton.addSelectionListener( new MyClearSelectionListener() ); // Installs the layout into the parent, and layout data on controls GridLayout layout = new GridLayout( 2, false ); layout.marginTop = 0; layout.marginRight = 0; layout.marginBottom = 0; layout.marginLeft = 0; layout.marginWidth = 0; layout.marginHeight = 0; parent.setLayout( layout ); combo.setLayoutData( new GridData(GridData.FILL_BOTH|GridData.GRAB_HORIZONTAL) ); // Post-condition assert combo != null; assert clearButton != null; } /** * @see eclox.ui.editor.advanced.filters.IFilter#createViewerFilters(org.eclipse.jface.viewers.StructuredViewer) */ public void createViewerFilters(StructuredViewer viewer) { // Pre-condition assert viewer == null; assert viewerFilter == null; // Installes the viewer filter. this.viewer = viewer; this.viewerFilter = new MyViewerFiler(); this.viewer.addFilter( this.viewerFilter ); // Post-condition assert this.viewer != null; assert this.viewerFilter != null; } /** * @see eclox.ui.editor.advanced.filters.IFilter#disposeControls() */ public void disposeControls() { // Pre-condition assert combo != null; assert clearButton != null; // Saves some state of the managed combo widget. this.savedComboItems = combo.getItems(); this.savedComboText = combo.getText(); // Disposes all managed widgets. combo.dispose(); clearButton.dispose(); combo = null; clearButton = null; // Post-condition assert combo == null; assert clearButton == null; } /** * @see eclox.ui.editor.advanced.filters.IFilter#disposeViewerFilers(org.eclipse.jface.viewers.StructuredViewer) */ public void disposeViewerFilers(StructuredViewer viewer) { // Pre-condition assert this.viewer != null; assert viewerFilter != null; // Uninstalles the viewer filter. viewer.removeFilter( this.viewerFilter ); this.viewerFilter = null; this.viewer = null; // Post-condition assert this.viewer == null; assert this.viewerFilter == null; } /** * @see eclox.ui.editor.advanced.filters.IFilter#getName() */ public String getName() { return "Custom"; } /** * @see eclox.ui.editor.advanced.filters.IFilter#setDoxyfile(eclox.doxyfiles.Doxyfile) */ public void setDoxyfile(Doxyfile doxyfile) { // Nothing to do. } } eclox/eclox.ui/src/eclox/ui/editor/advanced/filters/ByGroup.java 0000644 0001750 0000144 00000014704 12166012446 024260 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2005, 2013 Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced.filters; import org.eclipse.jface.viewers.StructuredViewer; import org.eclipse.jface.viewers.Viewer; import org.eclipse.jface.viewers.ViewerFilter; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.widgets.Combo; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.IManagedForm; import eclox.core.doxyfiles.Doxyfile; import eclox.core.doxyfiles.Group; import eclox.core.doxyfiles.Setting; /** * Implements a filter that shows settings by groups. * * @author gbrocker */ public class ByGroup implements IFilter { /** * the doxyfile being filtered */ private Doxyfile doxyfile; /** * the combo control displaying all group that are selectable by the user */ private Combo combo; /** * the saved combo selection index */ private int savedComboSelection = -1; /** * the current viewer beging filtered. */ private StructuredViewer viewer; /** * the current viewer filter that filters objects displayed in the setting viewer */ private MyViewerFilter viewerFilter; /** * Implements a selection listener for the managed combo control. */ private class MySelectionListener implements SelectionListener { /** * @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent) */ public void widgetDefaultSelected(SelectionEvent e) { // Pre-condition assert viewer != null; viewer.refresh(); } /** * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent) */ public void widgetSelected(SelectionEvent e) { // Pre-condition assert viewer != null; viewer.refresh(); } } /** * Implements a structure viewer filter that will filter setting according to the * selected group */ private class MyViewerFilter extends ViewerFilter { /** * @see org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object) */ public boolean select(Viewer viewer, Object parentElement, Object element) { // Pre-condition assert combo != null; assert element instanceof Setting; // Retrieves the selected group name. int groupIndex = combo.getSelectionIndex(); String groupName = groupIndex >= 0 ? combo.getItem( groupIndex ) : null; // Tests if the given element is in the right group. if( groupName != null ) { Setting setting = (Setting) element; String settingGroup = setting.getProperty( Setting.GROUP ); return (settingGroup != null) ? settingGroup.equals( groupName ) : false; } else { return false; } } } /** * @see eclox.ui.editor.advanced.filters.IFilter#setDoxyfile(eclox.doxyfiles.Doxyfile) */ public void setDoxyfile(Doxyfile doxyfile) { this.doxyfile = doxyfile; } /** * @see eclox.ui.editor.advanced.filters.IFilter#createControls(org.eclipse.ui.forms.IManagedForm, org.eclipse.swt.widgets.Composite) */ public void createControls( IManagedForm managedForm, Composite parent ) { // Pre-condition assert combo == null; assert doxyfile != null; // Creates the managed combo control. combo = new Combo( parent, SWT.FLAT|SWT.BORDER|SWT.READ_ONLY ); combo.addSelectionListener( new MySelectionListener() ); parent.setLayout( new FillLayout() ); // Fills the combo with group names. Object[] objects = doxyfile.getGroups(); int i; for( i = 0; i < objects.length; ++i ) { Group group = (Group) objects[i]; combo.add( group.getName() ); } // Restores the combo selection. combo.select( savedComboSelection ); // Post-condition assert combo != null; } /** * @see eclox.ui.editor.advanced.filters.IFilter#createViewerFilters(org.eclipse.jface.viewers.StructuredViewer) */ public void createViewerFilters(StructuredViewer viewer) { // Pre-condition assert this.viewerFilter == null; assert this.viewer == null; // Creates the viewer filter. this.viewerFilter = new MyViewerFilter(); this.viewer = viewer; this.viewer.addFilter( viewerFilter ); // Post-condition assert this.viewerFilter != null; assert this.viewer == viewer; } /** * @see eclox.ui.editor.advanced.filters.IFilter#disposeControls() */ public void disposeControls() { // Pre-condition assert combo != null; // Saves the combo selection. savedComboSelection = combo.getSelectionIndex(); // Diposes the managed combo control. combo.getParent().setLayout( null ); combo.dispose(); combo = null; // Post-condition assert combo == null; } /** * @see eclox.ui.editor.advanced.filters.IFilter#disposeViewerFilers(org.eclipse.jface.viewers.StructuredViewer) */ public void disposeViewerFilers(StructuredViewer viewer) { // Pre-condition assert this.viewerFilter != null; assert this.viewer == viewer; // Disposes the viewer filter. this.viewer.removeFilter( viewerFilter ); this.viewer = null; this.viewerFilter = null; // Post-condition assert this.viewerFilter == null; assert this.viewer == null; } /** * @see eclox.ui.editor.advanced.filters.IFilter#getName() */ public String getName() { return "By Group"; } } eclox/eclox.ui/src/eclox/ui/editor/advanced/filters/All.java 0000644 0001750 0000144 00000003611 12166012446 023374 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2005, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced.filters; import org.eclipse.jface.viewers.StructuredViewer; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.IManagedForm; import eclox.core.doxyfiles.Doxyfile; /** * Implements a setting filter that shows all settings. * * @author gbrocker */ public class All implements IFilter { /** * @see eclox.ui.editor.advanced.filters.IFilter#setDoxyfile(eclox.doxyfiles.Doxyfile) */ public void setDoxyfile(Doxyfile doxyfile) {} /** * @see eclox.ui.editor.advanced.filters.IFilter#createControls(org.eclipse.ui.forms.IManagedForm, org.eclipse.swt.widgets.Composite) */ public void createControls(IManagedForm managedForm, Composite parent) {} /** * @see eclox.ui.editor.advanced.filters.IFilter#createViewerFilters(org.eclipse.jface.viewers.StructuredViewer) */ public void createViewerFilters(StructuredViewer viewer) {} /** * @see eclox.ui.editor.advanced.filters.IFilter#disposeControls() */ public void disposeControls() {} /** * @see eclox.ui.editor.advanced.filters.IFilter#disposeViewerFilers(org.eclipse.jface.viewers.StructuredViewer) */ public void disposeViewerFilers(StructuredViewer viewer) {} /** * @see eclox.ui.editor.advanced.filters.IFilter#getName() */ public String getName() { return "All"; } } eclox/eclox.ui/src/eclox/ui/editor/advanced/filters/IFilter.java 0000644 0001750 0000144 00000004125 12166012446 024223 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2005, 2013 Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced.filters; import org.eclipse.jface.viewers.StructuredViewer; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.IManagedForm; import eclox.core.doxyfiles.Doxyfile; /** * Defines the interface for setting filters. * * @author gbrocker */ public interface IFilter { /** * Tells the filter which doxyfile is to filter. * * @param doxyfile a doxyfile instance */ void setDoxyfile( Doxyfile doxyfile ); /** * Asks the filter to create its user interface controls. * * @param managedForm a managed form to use for the widget creation * @param parent a composite being the parent of all widgets */ void createControls( IManagedForm managedForm, Composite parent ); /** * Asks the filter to create viewer filter and add them in a given viewer * * @param viewer a viewer where filter must be added */ void createViewerFilters( StructuredViewer viewer ); /** * Asks the filter to dispose its controls. */ void disposeControls(); /** * Asks the filter to dispose created viewer filter given a viewer * * @param viewer a structured view from which created viewer filter must be removed */ void disposeViewerFilers( StructuredViewer viewer ); /** * Retrieves the filter name. * * This name must by human readable sinci it is used in the graphical * user interface. * * @return a string containing the filter name */ String getName(); } eclox/eclox.ui/src/eclox/ui/editor/advanced/Page.java 0000644 0001750 0000144 00000003016 12166012446 022067 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2004, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced; import org.eclipse.ui.forms.IManagedForm; import org.eclipse.ui.forms.editor.FormPage; import eclox.ui.editor.Editor; /** * Implements the settings form page * * @author gbrocker */ public class Page extends FormPage { /** * The page identifier. */ public static final String ID = "advanced"; /** * The master/detail block. */ private Block block; /** * Constructor. * * @param editor the editor instance to attach to. * * @author gbrocker */ public Page(Editor editor) { super(editor, Page.ID, "Advanced"); block = new Block( editor.getDoxyfile() ); } /** * @see org.eclipse.ui.forms.editor.FormPage#createFormContent(org.eclipse.ui.forms.IManagedForm) */ protected void createFormContent(IManagedForm managedForm) { managedForm.getForm().setText(this.getTitle()); this.block.createContent(managedForm); } } eclox/eclox.ui/src/eclox/ui/editor/advanced/NavigableSelection.java 0000644 0001750 0000144 00000010122 12166012446 024745 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced; import java.util.Iterator; import java.util.List; import java.util.Stack; import java.util.Vector; import org.eclipse.jface.viewers.IStructuredSelection; /** * Implements a selection that provides the history of all selected * items as well as the navigation among those items. * * @author gbrocker */ public class NavigableSelection implements IStructuredSelection { private Stack previousElements = new Stack(); ///< Contains all previously selected elements. private Stack nextElements = new Stack(); ///< Contains all next selected elements. private Vector elements = new Vector(); ///< References the current element of the selection. /** * @brief Builds a new selection that holds the given object. * * @param object the new object to select * * @return the new selection */ public NavigableSelection select(Object object) { NavigableSelection result; if( getFirstElement() != object ) { result = new NavigableSelection(); if( isEmpty() == false ) { result.previousElements.addAll(previousElements); result.previousElements.push(elements.firstElement()); } result.elements.add(object); } else { result = this; } return result; } /** * @brief Retrieves the collection of items that follow the current item * in the history. * * @return a stack of items */ public Stack getNextElements() { return nextElements; } /** * @brief Builds the selection that follows in the history. * * @return a selection or null if none */ public NavigableSelection getNextSelection() { NavigableSelection result = null; if( nextElements.empty() == false ) { result = new NavigableSelection(); result.previousElements.addAll(previousElements); result.previousElements.push(elements.firstElement()); result.elements.add(nextElements.peek()); result.nextElements.addAll(nextElements); result.nextElements.pop(); } return result; } /** * @brief Retrieves the collection of items that preceed the current item * in the history. * * @return a stack of items */ public Stack getPreviousElements() { return previousElements; } /** * @brief Builds the selection that preceeds in the history. * * @return a selection or null if none */ public NavigableSelection getPreviousSelection() { NavigableSelection result = null; if( previousElements.empty() == false ) { result = new NavigableSelection(); result.previousElements.addAll(previousElements); result.previousElements.pop(); result.elements.add(previousElements.peek()); result.nextElements.addAll(nextElements); result.nextElements.push(elements.firstElement()); } return result; } /** * @see org.eclipse.jface.viewers.ISelection#isEmpty() */ public boolean isEmpty() { return elements.isEmpty(); } /** * Retrieves the selected element. * * @see org.eclipse.jface.viewers.IStructuredSelection#getFirstElement() */ public Object getFirstElement() { return elements.isEmpty() ? null : elements.firstElement(); } /** * @see org.eclipse.jface.viewers.IStructuredSelection#iterator() */ public Iterator iterator() { return elements.iterator(); } /** * @see org.eclipse.jface.viewers.IStructuredSelection#size() */ public int size() { return elements.size(); } /** * @see org.eclipse.jface.viewers.IStructuredSelection#toArray() */ public Object[] toArray() { return elements.toArray(); } /** * @see org.eclipse.jface.viewers.IStructuredSelection#toList() */ public List toList() { return new Vector(elements); } } eclox/eclox.ui/src/eclox/ui/editor/advanced/MasterPart.java 0000644 0001750 0000144 00000051450 12166012446 023302 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced; import java.util.HashSet; import java.util.Iterator; import java.util.Set; import org.eclipse.jface.viewers.DoubleClickEvent; import org.eclipse.jface.viewers.IDoubleClickListener; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.ISelectionChangedListener; import org.eclipse.jface.viewers.IStructuredContentProvider; import org.eclipse.jface.viewers.ITableLabelProvider; import org.eclipse.jface.viewers.LabelProvider; import org.eclipse.jface.viewers.LabelProviderChangedEvent; import org.eclipse.jface.viewers.SelectionChangedEvent; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.TableViewer; import org.eclipse.jface.viewers.Viewer; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.graphics.Image; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.layout.FormAttachment; import org.eclipse.swt.layout.FormData; import org.eclipse.swt.layout.FormLayout; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Table; import org.eclipse.swt.widgets.TableColumn; import org.eclipse.ui.ISharedImages; import org.eclipse.ui.PlatformUI; import org.eclipse.ui.forms.DetailsPart; import org.eclipse.ui.forms.IFormPart; import org.eclipse.ui.forms.IManagedForm; import org.eclipse.ui.forms.IPartSelectionListener; import org.eclipse.ui.forms.SectionPart; import org.eclipse.ui.forms.widgets.FormToolkit; import org.eclipse.ui.forms.widgets.Section; import eclox.core.doxyfiles.Doxyfile; import eclox.core.doxyfiles.ISettingPropertyListener; import eclox.core.doxyfiles.Setting; import eclox.ui.editor.Editor; import eclox.ui.editor.advanced.filters.All; import eclox.ui.editor.advanced.filters.ByGroup; import eclox.ui.editor.advanced.filters.Custom; import eclox.ui.editor.advanced.filters.IFilter; import eclox.ui.editor.advanced.filters.Modified; /** * Implements the master part's user interface. * * @author gbrocker */ public class MasterPart extends SectionPart implements IPartSelectionListener { /** * Implements the master content provider. */ private class MyContentProvider implements IStructuredContentProvider { /** * @see org.eclipse.jface.viewers.IContentProvider#dispose() */ public void dispose() {} /** * @see org.eclipse.jface.viewers.IStructuredContentProvider#getElements(java.lang.Object) */ public Object[] getElements(Object inputElement) { Doxyfile doxyfile = (Doxyfile) inputElement; return doxyfile.getSettings(); } /** * @see org.eclipse.jface.viewers.IContentProvider#inputChanged(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object) */ public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {} } /** * Implements the mouse listener attached to the table. * * This listener will search for a DetailsPart in the managed form given * at construction time and will set the focus on that part. */ private class MyDoubleClickListener implements IDoubleClickListener { /** * @see org.eclipse.jface.viewers.IDoubleClickListener#doubleClick(org.eclipse.jface.viewers.DoubleClickEvent) */ public void doubleClick(DoubleClickEvent event) { IManagedForm managedForm = getManagedForm(); // Searchs for the details part in the managed form and set the focus on it. IFormPart parts[] = managedForm.getParts(); for( int i = 0; i < parts.length; ++i ) { IFormPart currentPart = parts[i]; if( currentPart instanceof DetailsPart ) { currentPart.setFocus(); break; } } } } /** * Implements a filter button listener */ private class MyFilterButtonListener implements SelectionListener { /** * @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent) */ public void widgetDefaultSelected(SelectionEvent e) { Object data = e.widget.getData(); IFilter filter = (IFilter) data; activateFilter( filter ); } /** * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent) */ public void widgetSelected(SelectionEvent e) { Object data = e.widget.getData(); IFilter filter = (IFilter) data; activateFilter( filter ); } } /** * Implements the label provider. */ private class MyLabelProvider extends LabelProvider implements ITableLabelProvider, ISettingPropertyListener { /** * the set of all settings the label provider has registered to */ private Set settings = new HashSet(); /** * @see org.eclipse.jface.viewers.IBaseLabelProvider#dispose() */ public void dispose() { // Walks through all settings and unregisters from the listeners Iterator i = settings.iterator(); while( i.hasNext() == true ) { Object object = i.next(); Setting setting = (Setting) object; setting.removeSettingListener( this ); } settings.clear(); super.dispose(); } /** * @see org.eclipse.jface.viewers.ITableLabelProvider#getColumnImage(java.lang.Object, int) */ public Image getColumnImage(Object element, int columnIndex) { // We don't have any image to return. return null; } /** * @see org.eclipse.jface.viewers.ITableLabelProvider#getColumnText(java.lang.Object, int) */ public String getColumnText(Object element, int columnIndex) { // Pre-condition assert element instanceof Setting; // Retrieves the setting's text. Setting setting = (Setting) element; // Registers as an observer of the setting setting.addSettingListener( this ); settings.add( setting ); // Determine the text to return according to the given column index. String columnText; if( columnIndex == TEXT_COLUMN ) { columnText = setting.hasProperty( Setting.TEXT ) ? setting.getProperty( Setting.TEXT ) : setting.getIdentifier(); columnText = setting.hasProperty( Editor.PROP_SETTING_DIRTY ) ? ("*").concat( columnText ) : columnText; } else if (columnIndex == VALUE_COLUMN ){ columnText = setting.getValue(); } else { columnText = null; } return columnText; } public void settingPropertyChanged(Setting setting, String property) { if( property.equals( Editor.PROP_SETTING_DIRTY ) ) { fireLabelProviderChanged( new LabelProviderChangedEvent(this, setting) ); } } public void settingPropertyRemoved(Setting setting, String property) { if( property.equals( Editor.PROP_SETTING_DIRTY ) ) { fireLabelProviderChanged( new LabelProviderChangedEvent(this, setting) ); } } } /** * Implements a tree viewer selection listener. */ private class MyTableSelectionListener implements ISelectionChangedListener { /** * @see org.eclipse.jface.viewers.ISelectionChangedListener#selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent) */ public void selectionChanged(SelectionChangedEvent event) { ISelection selection = event.getSelection(); if( selection.isEmpty() == false ) { assert selection instanceof StructuredSelection; // Updates the selection StructuredSelection structuredSelection = (StructuredSelection) selection; setSelection( currentSelection.select(structuredSelection.getFirstElement()), false ); } } } /** the text column index */ private final static int TEXT_COLUMN = 0; /** the value column index */ private final static int VALUE_COLUMN = 1; /** the doxyfile being edited */ private Doxyfile doxyfile; /** the active filter */ private IFilter activeFilter; /** the default filter */ private IFilter defaultFilter = new All(); /** the parent composite for filter buttons */ private Composite filterButtons; /** the parent composite for filter controls */ private Composite filterControls; /** the list viewer */ private TableViewer tableViewer; /** the table viewer selection listener */ private MyTableSelectionListener tableViewerSelectionListener; /** the go backward history action */ private HistoryAction goBack = new HistoryAction(HistoryAction.BACK, this); /** the go foreward history action */ private HistoryAction goForward = new HistoryAction(HistoryAction.FORWARD, this); /** the current selection */ private NavigableSelection currentSelection = new NavigableSelection(); /** * Constructor * * @param parent a composite that is the parent of all part controls * @param toolkit a toolkit used to create the part controls. * @param doxyfile a doxyfile to edit */ public MasterPart( Composite parent, FormToolkit toolkit, Doxyfile doxyfile ) { super( parent, toolkit, Section.TITLE_BAR|Section.COMPACT ); this.doxyfile = doxyfile; // Initializes the managed section. Section section = getSection(); section.setText("Settings"); section.marginHeight = 5; section.marginWidth = 10; toolkit.paintBordersFor( section ); // Creates the main section container. Composite rootContainer = toolkit.createComposite( section ); section.setClient( rootContainer ); rootContainer.setLayout( new FormLayout() ); // Continues with other initializations. createFilterButtons( toolkit, rootContainer ); createSubControls( toolkit, rootContainer ); // Adds some filters. addFilter( toolkit, defaultFilter ); addFilter( toolkit, new ByGroup() ); addFilter( toolkit, new Custom() ); addFilter( toolkit, new Modified() ); // Activates the default filter. activateFilter( defaultFilter ); } /** * Activates the specified filter. * * @param filter a filter that must be activated */ private void activateFilter( IFilter filter ) { Section section = getSection(); // Freezes the section widget. section.setRedraw( false ); // Updates the filter button's state. Control[] controls = filterButtons.getChildren(); for( int i = 0; i < controls.length; ++i ) { Control control = controls[i]; Button button = (Button) control; button.setSelection( control.getData() == filter ); } // If there is a new filter to activate, do the activation job. if( filter != activeFilter ) { // Deactivates the previous filter. if( activeFilter != null ) { activeFilter.disposeViewerFilers( tableViewer ); activeFilter.disposeControls(); activeFilter.setDoxyfile( null ); activeFilter = null; } // Activates the new filter. activeFilter = filter; activeFilter.setDoxyfile( doxyfile ); activeFilter.createControls( getManagedForm(), filterControls ); activeFilter.createViewerFilters( tableViewer ); tableViewer.refresh(); // Adapts the size of the filter control container & relayout the section content. Object tableLayoutData = tableViewer.getTable().getLayoutData(); FormData tableFormData = (FormData) tableLayoutData; if( filterControls.getChildren().length == 0 ) { filterControls.setVisible( false ); tableFormData.top = new FormAttachment( 0, 0 ); } else { filterControls.setVisible( true ); tableFormData.top = new FormAttachment( filterControls, 6, SWT.BOTTOM ); } // Reactivates section widget. section.layout( true, true ); } // Reactivates the redrawing. section.setRedraw( true ); } /** * Adds a new filter to the master part. * * @param toolkit a toolkit to use for the widget creation * @param filter a new filter to add */ private void addFilter( FormToolkit toolkit, IFilter filter ) { Button button = toolkit.createButton( filterButtons, filter.getName(), SWT.FLAT|SWT.TOGGLE); button.setData( filter ); button.addSelectionListener( new MyFilterButtonListener() ); } /** * Creates all buttons for setting filters. * * @param toolkit the form tool to use for the control creation * @param parent a composite that will be the parent of all controls */ private void createFilterButtons( FormToolkit toolkit, Composite parent ) { // Pre-condition assert filterButtons == null; assert filterControls == null; // Creates the filter button container. FillLayout buttonContainerLayout = new FillLayout( SWT.HORIZONTAL ); filterButtons = toolkit.createComposite( parent ); buttonContainerLayout.marginWidth = 0; buttonContainerLayout.marginHeight = 0; buttonContainerLayout.spacing = 3; filterButtons.setLayout( buttonContainerLayout ); // Assignes layout data fo the filter button container. FormData buttonFormData = new FormData(); buttonFormData.top = new FormAttachment( 0, 0 ); buttonFormData.right = new FormAttachment( 100, 0 ); buttonFormData.left = new FormAttachment( 0, 0 ); filterButtons.setLayoutData( buttonFormData ); // Post-condition assert filterButtons != null; } /** * Creates controls subordinated to the filter buttons. */ private void createSubControls( FormToolkit toolkit, Composite parent ) { // Pre-condition assert filterButtons != null; assert filterControls == null; assert tableViewer == null; toolkit.paintBordersFor( parent ); // Creates the sub parent control container. Composite subParent = toolkit.createComposite( parent ); FormData subParentFormData = new FormData(); subParentFormData.top = new FormAttachment( filterButtons, 6, SWT.BOTTOM ); subParentFormData.right = new FormAttachment( 100, -2 ); subParentFormData.bottom = new FormAttachment( 100, -2 ); subParentFormData.left = new FormAttachment( 0, 1 ); subParentFormData.height = 50; subParent.setLayoutData( subParentFormData ); subParent.setLayout( new FormLayout() ); subParent.setData( FormToolkit.KEY_DRAW_BORDER, FormToolkit.TEXT_BORDER ); // Creates the filter control container. FormData controlFormData = new FormData(); controlFormData.top = new FormAttachment( 0, 5 ); controlFormData.right = new FormAttachment( 100, -5 ); controlFormData.left = new FormAttachment( 0, 5 ); filterControls = toolkit.createComposite( subParent ); filterControls.setLayoutData( controlFormData ); // Creates the table widget that will display all settings. Table table = new Table( subParent, SWT.V_SCROLL|SWT.FULL_SELECTION ); FormData formData = new FormData(); formData.top = new FormAttachment( filterControls, 5, SWT.BOTTOM ); formData.right = new FormAttachment( 100, 0 ); formData.bottom = new FormAttachment( 100, 0 ); formData.left = new FormAttachment( 0, 0 ); formData.height = 10; formData.width = 10; table.setLayoutData( formData ); table.setHeaderVisible( true ); // Adds some columns to the table TableColumn tableColumn; tableColumn = new TableColumn( table, SWT.LEFT, TEXT_COLUMN ); tableColumn.setText( "Name" ); tableColumn = new TableColumn( table, SWT.LEFT, VALUE_COLUMN ); tableColumn.setText( "Value" ); // Creates the table viewer. tableViewer = new TableViewer( table ); tableViewer.setContentProvider( new MyContentProvider() ); tableViewer.setLabelProvider( new MyLabelProvider() ); tableViewer.setInput( doxyfile ); // Updates the column widths. TableColumn columns[] = table.getColumns(); columns[ TEXT_COLUMN ].pack(); columns[ VALUE_COLUMN ].pack(); // Post-condition assert filterControls != null; assert tableViewer != null; } /** * @see org.eclipse.ui.forms.AbstractFormPart#initialize(org.eclipse.ui.forms.IManagedForm) */ public void initialize(IManagedForm form) { // Pre-condition assert tableViewer != null; // Installs several listeners. tableViewerSelectionListener = new MyTableSelectionListener(); tableViewer.addPostSelectionChangedListener( tableViewerSelectionListener ); tableViewer.addDoubleClickListener( new MyDoubleClickListener() ); // Installs the actions goBack.setImageDescriptor(PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_BACK)); goForward.setImageDescriptor(PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_FORWARD)); form.getForm().getToolBarManager().add(goBack); form.getForm().getToolBarManager().add(goForward); goBack.selectionChanged(new NavigableSelection()); goForward.selectionChanged(new NavigableSelection()); // Default job done by super class. super.initialize(form); } /** * @see org.eclipse.ui.forms.AbstractFormPart#isStale() */ public boolean isStale() { // We always answer yes because it is currently not trivial // to know if the data model has changed since last refresh. return true; } /** * @see org.eclipse.ui.forms.AbstractFormPart#refresh() */ public void refresh() { tableViewer.refresh(); super.refresh(); } /** * @see org.eclipse.ui.forms.IPartSelectionListener#selectionChanged(org.eclipse.ui.forms.IFormPart, org.eclipse.jface.viewers.ISelection) */ public void selectionChanged(IFormPart part, ISelection selection) { assert selection instanceof NavigableSelection; currentSelection = (NavigableSelection) selection; // Activates the default filter. activateFilter( defaultFilter ); revealObject(currentSelection.getFirstElement()); // Updates the navigation actions. goBack.selectionChanged(selection); goForward.selectionChanged(selection); } /** * Set the new selection of the part. This will forward the selection to the form * so other parts will be notified about the selection change. * * @param selection the new selection * @param reveal tells if the selection should be revealed in the controls */ public void setSelection( NavigableSelection selection, boolean reveal ) { currentSelection = selection; // If requested, reveals the selection's first element if( reveal == true ) { revealObject(selection.getFirstElement()); } // Updates the actions goBack.selectionChanged(currentSelection); goForward.selectionChanged(currentSelection); // Notifies other parts. getManagedForm().fireSelectionChanged(this, selection); } /** * Reveals the given object into the managed table viewer by selecting it. * * @param object the object to reveal */ private void revealObject(Object object) { StructuredSelection selection = (object != null) ? new StructuredSelection(object) : new StructuredSelection(); tableViewer.removePostSelectionChangedListener(tableViewerSelectionListener); tableViewer.setSelection(selection, true); tableViewer.addPostSelectionChangedListener(tableViewerSelectionListener); } } eclox/eclox.ui/src/eclox/ui/editor/advanced/EditorClassRegister.java 0000644 0001750 0000144 00000004605 12166012446 025141 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2005, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced; import java.util.HashMap; import java.util.Map; import eclox.core.doxyfiles.Setting; import eclox.ui.Plugin; import eclox.ui.editor.editors.BooleanEditor; import eclox.ui.editor.editors.DirectoryEditor; import eclox.ui.editor.editors.DirectoryListEditor; import eclox.ui.editor.editors.FileEditor; import eclox.ui.editor.editors.PathListEditor; import eclox.ui.editor.editors.TextEditor; import eclox.ui.editor.editors.TextListEditor; /** * An instance of this class registers all setting editor classes by setting type. * * @author gbrocker */ public class EditorClassRegister { /** * The map registering all editor classes. */ private Map register = new HashMap(); /** * Constructor. */ public EditorClassRegister() { register.put( "file", FileEditor.class ); register.put( "directory", DirectoryEditor.class ); register.put( "text", TextEditor.class ); register.put( "boolean", BooleanEditor.class ); register.put( "text list", TextListEditor.class ); register.put( "directory list", DirectoryListEditor.class ); register.put( "path list", PathListEditor.class ); } /** * Retrieves a class for the specified setting. * * @param setting a setting for which an editor must be retrieved * * @return a setting editor class */ public Class find(Setting setting) { // Retrieves the editor class for that type String type = setting.getProperty( Setting.TYPE ); Class result = (Class) register.get(type); // Little fallback if no matching editor class was found. if(result == null) { Plugin.log(setting.getIdentifier() + ": missing or wrong TYPE property."); result = TextEditor.class; } return result; } } eclox/eclox.ui/src/eclox/ui/editor/advanced/Block.java 0000644 0001750 0000144 00000003630 12166012446 022247 0 ustar willy users /* /******************************************************************************* * Copyright (C) 2003-2004, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.advanced; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.DetailsPart; import org.eclipse.ui.forms.IManagedForm; import org.eclipse.ui.forms.MasterDetailsBlock; import eclox.core.doxyfiles.Doxyfile; import eclox.core.doxyfiles.Setting; /** * @author gbrocker */ public class Block extends MasterDetailsBlock { /** * the doxyfile to edit */ private Doxyfile doxyfile; /** * Constructor * * @param doxyfile the doxyfile to edit */ Block( Doxyfile doxyfile ) { this.doxyfile = doxyfile; } /** * @see org.eclipse.ui.forms.MasterDetailsBlock#createMasterPart(org.eclipse.ui.forms.IManagedForm, org.eclipse.swt.widgets.Composite) */ protected void createMasterPart(IManagedForm managedForm, Composite parent) { managedForm.addPart( new MasterPart(parent, managedForm.getToolkit(), doxyfile) ); } /** * @see org.eclipse.ui.forms.MasterDetailsBlock#registerPages(org.eclipse.ui.forms.DetailsPart) */ protected void registerPages(DetailsPart detailsPart) { detailsPart.registerPage(Setting.class, new DetailsPage()); } /** * @see org.eclipse.ui.forms.MasterDetailsBlock#createToolBarActions(org.eclipse.ui.forms.IManagedForm) */ protected void createToolBarActions(IManagedForm managedForm) {} } eclox/eclox.ui/src/eclox/ui/editor/basic/ 0000755 0001750 0000144 00000000000 12315037715 017666 5 ustar willy users eclox/eclox.ui/src/eclox/ui/editor/basic/ProjectPart.java 0000644 0001750 0000144 00000005420 12166012446 022765 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2008, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; import eclox.core.doxyfiles.Doxyfile; import eclox.ui.editor.editors.CheckBoxEditor; import eclox.ui.editor.editors.DirectoryEditor; import eclox.ui.editor.editors.DirectoryListEditor; import eclox.ui.editor.editors.TextEditor; /** * Implements the part that will provide editior for the project settings. * * @author gbrocker */ public class ProjectPart extends Part { /** * the project name setting editor */ private TextEditor nameEditor = new TextEditor(); /** * the project version or identifier editor */ private TextEditor versionEditor = new TextEditor(); /** * the project input editor */ private DirectoryListEditor inputEditor = new DirectoryListEditor(); /** * the recursive scan editor */ private CheckBoxEditor recursiveEditor = new CheckBoxEditor("Scan recursively"); /** * the project output editor */ private DirectoryEditor outputEditor = new DirectoryEditor(); /** * Constructor * * @param parent the parent composite of the part content * @param toolkit the toolkit to use for control creations * @param doxyfile the doxyfile being edited */ ProjectPart( Composite parent, FormToolkit toolkit, Doxyfile doxyfile ) { super( parent, toolkit, "Project", doxyfile ); addEditor("Name:", nameEditor); addEditor("Version or Identifier:", versionEditor); addSperator(); addLabel("Input directories:"); addEditor(inputEditor); addEditor(recursiveEditor); addSperator(); addEditor("Output Directory:", outputEditor); nameEditor .setInput( doxyfile.getSetting("PROJECT_NAME") ); versionEditor .setInput( doxyfile.getSetting("PROJECT_NUMBER") ); inputEditor .setInput( doxyfile.getSetting("INPUT") ); outputEditor .setInput( doxyfile.getSetting("OUTPUT_DIRECTORY") ); recursiveEditor.setInput( doxyfile.getSetting("RECURSIVE") ); nameEditor .setEnabled( nameEditor.hasInput() ); versionEditor .setEnabled( versionEditor.hasInput() ); inputEditor .setEnabled( inputEditor.hasInput() ); outputEditor .setEnabled( outputEditor.hasInput() ); recursiveEditor.setEnabled( recursiveEditor.hasInput() ); } } eclox/eclox.ui/src/eclox/ui/editor/basic/Page.java 0000644 0001750 0000144 00000006601 12166012446 021406 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.SWT; import org.eclipse.swt.layout.FormAttachment; import org.eclipse.swt.layout.FormData; import org.eclipse.swt.layout.FormLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.IManagedForm; import org.eclipse.ui.forms.editor.FormPage; import org.eclipse.ui.forms.widgets.FormToolkit; import eclox.core.doxyfiles.Doxyfile; import eclox.ui.editor.Editor; /** * Implements the overview page. * * @author gbrocker */ public class Page extends FormPage { /** * The page identifier. */ public static final String ID = "basic"; /** * the doxyfile being edited */ private Doxyfile doxyfile; /** * Constructor. */ public Page(Editor editor) { super(editor, Page.ID, "Basic"); doxyfile = editor.getDoxyfile(); } /** * @see org.eclipse.ui.forms.editor.FormPage#createFormContent(org.eclipse.ui.forms.IManagedForm) */ protected void createFormContent(IManagedForm managedForm) { FormToolkit toolkit = managedForm.getToolkit(); Composite parent = managedForm.getForm().getBody(); managedForm.getForm().setText(this.getTitle()); // Creates all parts of the form. ProjectPart projectPart = new ProjectPart( parent, toolkit, doxyfile ); OutputPart outputPart = new OutputPart( parent, toolkit, doxyfile ); ModePart modePart = new ModePart( parent, toolkit, doxyfile ); DiagramsPart diagramsPart = new DiagramsPart( parent, toolkit, doxyfile ); managedForm.addPart(projectPart); managedForm.addPart(outputPart); managedForm.addPart(modePart); managedForm.addPart(diagramsPart); // Creates the layout. FormLayout layout = new FormLayout(); layout.marginWidth = 16; layout.marginHeight = 16; layout.spacing = 20; parent.setLayout(layout); FormData data; data = new FormData(); data.top = new FormAttachment(0); data.right = new FormAttachment(50); data.bottom = new FormAttachment(modePart.getSection(), 0, SWT.TOP); data.left = new FormAttachment(0); projectPart.getSection().setLayoutData(data); data = new FormData(); data.top = new FormAttachment(0); data.right = new FormAttachment(100); data.bottom = new FormAttachment(diagramsPart.getSection(), 0, SWT.TOP); data.left = new FormAttachment(projectPart.getSection(), 0, SWT.RIGHT); outputPart.getSection().setLayoutData(data); data = new FormData(); data.right = new FormAttachment(50); data.bottom = new FormAttachment(100); data.left = new FormAttachment(0); modePart.getSection().setLayoutData(data); data = new FormData(); data.top = new FormAttachment(outputPart.getSection(), 0, SWT.BOTTOM); data.right = new FormAttachment(100); data.left = new FormAttachment(modePart.getSection(), 0, SWT.RIGHT); diagramsPart.getSection().setLayoutData(data); super.createFormContent(managedForm); } } eclox/eclox.ui/src/eclox/ui/editor/basic/CheckMultiEditor.java 0000644 0001750 0000144 00000006610 12166012446 023731 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; /** * Implements a specialized multi editor that is represented by a check box and * provides only two states: SELECTED and DESELECTED. * * @author Guillaume Brocker */ public class CheckMultiEditor extends MultiEditor { /** * the selected state name constant */ public static final String SELECTED = "Selected"; /** * the deselected state name constant */ public static final String DESELECTED = "Deselected"; /** * Defines the selection listener for the check box button */ private class MySelectionListener implements SelectionListener { public void widgetDefaultSelected(SelectionEvent e) { widgetSelected(e); } public void widgetSelected(SelectionEvent e) { Button button = (Button) e.widget; selectState( button.getSelection() ? SELECTED : DESELECTED ); commit(); } } /** * a string containing the text to use for the check box button */ private String text; /** * the check box button that represents the editor */ private Button button; /** * Constructor * * @param text a string containing the text that will be used for the check box control */ public CheckMultiEditor( String text ) { super( new String[] {SELECTED, DESELECTED} ); this.text = text; } /** * @see eclox.ui.editor.editors.IEditor#createContent(org.eclipse.swt.widgets.Composite, org.eclipse.ui.forms.widgets.FormToolkit) */ public void createContent(Composite parent, FormToolkit formToolkit) { button = formToolkit.createButton(parent, text, SWT.CHECK); button.addSelectionListener( new MySelectionListener() ); parent.setLayout(new FillLayout(SWT.VERTICAL)); } /** * @see eclox.ui.editor.editors.IEditor#dispose() */ public void dispose() { button = null; } /** * @see eclox.ui.editor.editors.IEditor#grabVerticalSpace() */ public boolean grabVerticalSpace() { return false; } /** * @see eclox.ui.editor.basic.MultiEditor#refresh() */ public void refresh() { // Pre-condition assert button != null; // Refreshes the states. super.refresh(); // Refreshes the check box State selection = getSelectionAsState(); button.setSelection( selection != null && selection.getName().equals(SELECTED) ); } /** * @see eclox.ui.editor.editors.IEditor#setEnabled(boolean) */ public void setEnabled(boolean enabled) { // Pre-condition assert button != null; button.setEnabled(enabled); } /** * @see eclox.ui.editor.editors.IEditor#setFocus() */ public void setFocus() { // Pre-condition assert button != null; button.setFocus(); } } eclox/eclox.ui/src/eclox/ui/editor/basic/ComboMultiEditor.java 0000644 0001750 0000144 00000007034 12166012446 023754 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.widgets.Combo; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; /** * Implements a multi editor that presents choices in a combo box. * * @author Guillaume Brocker */ public class ComboMultiEditor extends MultiEditor { /** * Implements a selection listener that will handle selection changes in the combo control. */ private class MySelectionListener implements SelectionListener { /** * @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent) */ public void widgetDefaultSelected(SelectionEvent e) { widgetSelected(e); } /** * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent) */ public void widgetSelected(SelectionEvent e) { selectState( combo.getItem(combo.getSelectionIndex()) ); commit(); } } /** * the combo control that is the representation of the editor */ Combo combo; /** * Constructor * * @param states an array of string representing all posible states */ ComboMultiEditor( String [] states ) { super( states ); } /** * @see eclox.ui.editor.editors.IEditor#createContent(org.eclipse.swt.widgets.Composite, org.eclipse.ui.forms.widgets.FormToolkit) */ public void createContent(Composite parent, FormToolkit formToolkit) { // Pre-condition assert combo != null; // Creates the combo control. combo = new Combo(parent, SWT.DROP_DOWN|SWT.READ_ONLY); combo.addSelectionListener( new MySelectionListener() ); formToolkit.adapt(combo, true, true); // Fills the combo with the state names. for( int i = 0; i != states.length; ++i ) { combo.add( states[i].getName() ); } combo.setVisibleItemCount(states.length); // Installs a layout in the parent composite parent.setLayout(new FillLayout()); } /** * @see eclox.ui.editor.editors.IEditor#dispose() */ public void dispose() { combo = null; } /** * @see eclox.ui.editor.editors.IEditor#grabVerticalSpace() */ public boolean grabVerticalSpace() { return false; } /** * @see eclox.ui.editor.basic.MultiEditor#refresh() */ public void refresh() { // Pre-condition assert combo != null; super.refresh(); // Selectes the string corresponding to the current selection State selection = getSelectionAsState(); if( selection != null ) { combo.select( combo.indexOf(selection.getName()) ); } else { combo.deselectAll(); } } /** * @see eclox.ui.editor.editors.IEditor#setEnabled(boolean) */ public void setEnabled(boolean enabled) { // Pre-condition assert combo != null; combo.setEnabled(enabled); } /** * @see eclox.ui.editor.editors.IEditor#setFocus() */ public void setFocus() { // Pre-condition assert combo != null; combo.setFocus(); } } eclox/eclox.ui/src/eclox/ui/editor/basic/ModePart.java 0000644 0001750 0000144 00000011005 12166012446 022237 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; import eclox.core.doxyfiles.Doxyfile; /** * Implements the form part that provides edition of mode related settings. * * @author Guillaume Brocker */ public class ModePart extends Part { /** * state for the entities editor */ private static final String ENTITIES_DOCUMENTED = "documented entities only"; /** * state for the entities editor */ private static final String ENTITIES_ALL = "all entities"; /** * state for the optimized langage editor */ private static final String CXX = "C++"; /** * state for the optimized langage editor */ private static final String JAVA = "Java"; /** * state for the optimized langage editor */ private static final String C = "C"; /** * state for the optimized langage editor */ private static final String C_SHARP = "C#"; /** * the editor used to configure entities whose documentation will be extracted */ private RadioMultiEditor entities = new RadioMultiEditor( new String[] {ENTITIES_DOCUMENTED, ENTITIES_ALL} ); /** * the editor used to configure cross-referenced source code inclusion */ private CheckMultiEditor crossReferenced = new CheckMultiEditor( "Include cross-referenced source code in the output" ); /** * the editor used to selected the optimized ouput langage */ private RadioMultiEditor optimizedLangage = new RadioMultiEditor( new String[] {CXX, JAVA, C, C_SHARP} ); /** * Constructor * * @param parent the parent control for the part control's * @param toolkit the toolkit to use for control creation * @param doxyfile the doxyfile being edited */ public ModePart( Composite parent, FormToolkit toolkit, Doxyfile doxyfile ) { super( parent, toolkit, "Mode", doxyfile ); // Creates the content. addLabel("Select the desired extraction mode:"); addEditor(entities); addEditor(crossReferenced); addSperator(); addLabel("Optimize results for:"); addEditor( optimizedLangage ); // Initializes the editors. if( doxyfile.hasSetting("HIDE_UNDOC_MEMBERS") && doxyfile.hasSetting("HIDE_UNDOC_CLASSES") && doxyfile.hasSetting("EXTRACT_ALL") && doxyfile.hasSetting("EXTRACT_PRIVATE") && doxyfile.hasSetting("EXTRACT_STATIC") ) { entities.addSetting(ENTITIES_DOCUMENTED, doxyfile.getSetting("HIDE_UNDOC_MEMBERS") ); entities.addSetting(ENTITIES_DOCUMENTED, doxyfile.getSetting("HIDE_UNDOC_CLASSES") ); entities.addSetting(ENTITIES_ALL, doxyfile.getSetting("EXTRACT_ALL") ); entities.addSetting(ENTITIES_ALL, doxyfile.getSetting("EXTRACT_PRIVATE") ); entities.addSetting(ENTITIES_ALL, doxyfile.getSetting("EXTRACT_STATIC") ); } else { entities.setEnabled( false ); } if( doxyfile.hasSetting("SOURCE_BROWSER") && doxyfile.hasSetting("REFERENCED_BY_RELATION") && doxyfile.hasSetting("REFERENCES_RELATION") && doxyfile.hasSetting("VERBATIM_HEADERS") ) { crossReferenced.addSetting(CheckMultiEditor.SELECTED, doxyfile.getSetting("SOURCE_BROWSER") ); crossReferenced.addSetting(CheckMultiEditor.SELECTED, doxyfile.getSetting("REFERENCED_BY_RELATION") ); crossReferenced.addSetting(CheckMultiEditor.SELECTED, doxyfile.getSetting("REFERENCES_RELATION") ); crossReferenced.addSetting(CheckMultiEditor.SELECTED, doxyfile.getSetting("VERBATIM_HEADERS") ); } else { crossReferenced.setEnabled(false); } if( doxyfile.hasSetting("OPTIMIZE_OUTPUT_JAVA") && doxyfile.hasSetting("OPTIMIZE_OUTPUT_FOR_C") && doxyfile.hasSetting("OPTIMIZE_OUTPUT_JAVA") && doxyfile.hasSetting("EXTRACT_STATIC") ) { optimizedLangage.addSetting(JAVA, doxyfile.getSetting("OPTIMIZE_OUTPUT_JAVA") ); optimizedLangage.addSetting(C, doxyfile.getSetting("OPTIMIZE_OUTPUT_FOR_C") ); optimizedLangage.addSetting(C_SHARP, doxyfile.getSetting("OPTIMIZE_OUTPUT_JAVA") ); optimizedLangage.addSetting(C_SHARP, doxyfile.getSetting("EXTRACT_STATIC") ); } else { optimizedLangage.setEnabled(false); } } } eclox/eclox.ui/src/eclox/ui/editor/basic/Part.java 0000644 0001750 0000144 00000015173 12166012446 021444 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import java.util.Collection; import java.util.Iterator; import java.util.Vector; import org.eclipse.swt.SWT; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Label; import org.eclipse.ui.forms.IFormColors; import org.eclipse.ui.forms.SectionPart; import org.eclipse.ui.forms.widgets.FormToolkit; import org.eclipse.ui.forms.widgets.Section; import eclox.core.doxyfiles.Doxyfile; import eclox.ui.editor.editors.IEditor; /** * Implements a specialized part that provide convenient features * to build user interfaces and manage editor life-cycles. * * @author gbrocker */ public class Part extends SectionPart { /** * The managed collection of editors */ private Collection editors = new Vector(); /** * The content of the section control */ private Composite content; /** * The toolkit used for control creation */ private FormToolkit toolkit; /** * The accumulation of separation spaces */ private int spacer = 0; /** * the doxyfile being edited */ protected Doxyfile doxyfile; /** * Contructor * * @param parent the parent control * @param tk the toolit used to create controls * @param title the title of the part * @param doxyfile the doxyfile being edited */ public Part(Composite parent, FormToolkit tk, String title, Doxyfile doxyfile) { super( parent, tk, Section.TITLE_BAR/*|Section.EXPANDED|Section.TWISTIE*/ ); this.doxyfile = doxyfile; // Initializes the section and its client component. Section section = getSection(); GridLayout layout = new GridLayout(); toolkit = tk; content = toolkit.createComposite(section); layout.numColumns = 2; layout.marginTop = 0; layout.marginRight = 0; layout.marginBottom = 0; layout.marginLeft = 0; layout.marginHeight = 0; layout.marginWidth = 0; layout.verticalSpacing = 2; content.setLayout( layout ); section.setText(title); section.setClient(content); } /** * Adds a new label to the part * * @param text the text of the label */ protected void addLabel( String text ) { Label label = toolkit.createLabel(content, text, SWT.WRAP); GridData data = new GridData(SWT.FILL, SWT.FILL, true, false); data.horizontalSpan = 2; data.verticalIndent = spacer; label.setLayoutData(data); spacer = 0; } /** * Adds the given editor instance to the part, with the given label. * * The editor life-cycle will get managed by the part. * * @param text a string containing a label text * @param editor an editor instance */ protected void addEditor( String text, IEditor editor ) { addEditor( text, editor, 0 ); } /** * Adds the given editor instance to the part, with the given label. * * The editor life-cycle will get managed by the part. * * @param text a string containing a label text * @param editor an editor instance * @param indent an extra margin that will be added to the left side of the editor's cell */ protected void addEditor( String text, IEditor editor, int indent ) { // Creates the controls Label label = toolkit.createLabel(content, text); Composite container = toolkit.createComposite(content); GridData labelData = new GridData(SWT.FILL, SWT.CENTER, false, false); GridData containerData = new GridData(SWT.FILL, SWT.FILL, true, false); labelData.verticalIndent = spacer; labelData.horizontalIndent = indent; labelData.grabExcessVerticalSpace = editor.grabVerticalSpace(); containerData.verticalIndent = spacer; containerData.grabExcessVerticalSpace = editor.grabVerticalSpace(); label.setLayoutData(labelData); label.setForeground(toolkit.getColors().getColor(IFormColors.TITLE)); container.setLayoutData(containerData); editor.createContent(container, toolkit); spacer = 0; // Registers the editor editors.add(editor); } /** * Adds the given editor instance to the part * * The editor life-cycle will get managed by the part. * * @param editor an editor instance */ protected void addEditor( IEditor editor ) { addEditor( editor, 0 ); } /** * Adds the given editor instance to the part * * The editor life-cycle will get managed by the part. * * @param editor an editor instance * @param indent an extra margin that will be added to the left side of the editor's cell */ protected void addEditor( IEditor editor, int indent ) { // Create the controls Composite container = toolkit.createComposite(content); GridData data = new GridData(SWT.FILL, SWT.FILL, true, false); data.verticalIndent = spacer; data.horizontalSpan = 2; data.horizontalIndent = indent; data.grabExcessVerticalSpace = editor.grabVerticalSpace(); editor.createContent(container, toolkit); container.setLayoutData(data); spacer = 0; // Registers the editor editors.add(editor); } /** * Adds a new separator to the part */ protected void addSperator() { spacer += 8; } /** * @see org.eclipse.ui.forms.AbstractFormPart#isDirty() */ public boolean isDirty() { boolean dirty = super.isDirty(); Iterator i = editors.iterator(); while( i.hasNext() && !dirty ) { IEditor editor = (IEditor) i.next(); dirty = editor.isDirty(); } return dirty; } /** * @see org.eclipse.ui.forms.AbstractFormPart#isStale() */ public boolean isStale() { boolean stale = super.isStale(); Iterator i = editors.iterator(); while( i.hasNext() && !stale ) { IEditor editor = (IEditor) i.next(); stale = editor.isStale(); } return stale; } /** * @see org.eclipse.ui.forms.AbstractFormPart#refresh() */ public void refresh() { super.refresh(); Iterator i = editors.iterator(); while( i.hasNext() ) { IEditor editor = (IEditor) i.next(); editor.refresh(); } } /** * @see org.eclipse.ui.forms.AbstractFormPart#commit(boolean) */ public void commit(boolean onSave) { super.commit(onSave); Iterator i = editors.iterator(); while( i.hasNext() ) { IEditor editor = (IEditor) i.next(); if( editor.isDirty() ) { editor.commit(); } } } } eclox/eclox.ui/src/eclox/ui/editor/basic/MultiEditor.java 0000644 0001750 0000144 00000013257 12166012446 023000 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import java.util.HashSet; import java.util.Iterator; import java.util.Set; import eclox.core.doxyfiles.Setting; import eclox.ui.editor.editors.AbstractEditor; /** * Base implementation of for multi editors. * * @author Guillaume Brocker */ public abstract class MultiEditor extends AbstractEditor { /** * symbolic constant value for yes */ private static final String YES = "YES"; /** * symbolic constant value for no */ private static final String NO = "NO"; protected class State { private String name; private Set selectedSettings = new HashSet(); private Set deselectedSettings = new HashSet(); State( String name ) { this.name = name; } void addSettingToSelect( Setting setting ) { selectedSettings.add( setting ); deselectedSettings.remove( setting ); } void addSettingToDeselect( Setting setting ) { if( selectedSettings.contains(setting) == false ) { deselectedSettings.add( setting ); } } String getName() { return name; } boolean wantsSelection() { boolean wanted = true; Iterator i; // Updates the selection according to the value of settings owned by the state. i = selectedSettings.iterator(); while( i.hasNext() ) { Setting setting = (Setting) i.next(); wanted = wanted && setting.getValue().equals(YES); } // Updates the selection according to the value of settings owned by the state. i = deselectedSettings.iterator(); while( i.hasNext() ) { Setting setting = (Setting) i.next(); wanted = wanted && setting.getValue().equals(NO); } // Job's done. return wanted; } void commit() { Iterator i; i = selectedSettings.iterator(); while( i.hasNext() ) { Setting setting = (Setting) i.next(); setting.setValue(YES); } i = deselectedSettings.iterator(); while( i.hasNext() ) { Setting setting = (Setting) i.next(); setting.setValue(NO); } } } /** * the collection of managed states */ protected State [] states; /** * the state being selected */ private State selection; /** * a boolean telling if the editor is dirty */ private boolean dirty = false; /** * Creates a new multi editor instance * * @param states an array containing the name of the states to create */ public MultiEditor( String [] states ) { this.states = new State[states.length]; for( int i = 0; i != states.length; ++i ) { this.states[i] = new State(states[i]); } } /** * Adds the given setting to a given state * * @param state the name of a state * @param setting the setting to add to the given state */ public void addSetting( String state, Setting setting ) { if( setting != null ) { for( int i = 0; i != states.length; ++i ) { if( states[i].name.equals(state) ) { states[i].addSettingToSelect(setting); } else { states[i].addSettingToDeselect(setting); } } } } /** * @see eclox.ui.editor.editors.IEditor#commit() */ public void commit() { // Commits the selected state. if( selection != null ) { selection.commit(); } dirty = false; fireEditorChanged(); } /** * Retrieves the selected state of the editor * * @return a string representing the selected state, or null if none */ public String getSelection() { return (selection != null) ? selection.getName() : null; } /** * @see eclox.ui.editor.editors.IEditor#isDirty() */ public boolean isDirty() { return dirty; } /** * @see eclox.ui.editor.editors.IEditor#isStale() */ public boolean isStale() { // Looks for the state that wants the selection. State wantedSelection = null; for( int i = 0; i != states.length; ++i ) { if( states[i].wantsSelection() ) { wantedSelection = states[i]; break; } } return wantedSelection != selection; } /** * Sub-classes must call this method first, in order to refresh the current state * and then refresh the user interface controls, according to the current state. * * @see eclox.ui.editor.editors.IEditor#refresh() */ public void refresh() { selection = null; dirty = false; // Searches the states that wants to be selected for( int i = 0; i != states.length; ++i ) { if( states[i].wantsSelection() ) { selection = states[i]; break; } } fireEditorChanged(); } /** * Retrieves the selected state of the multi editor. * * @return a state or null when none */ protected State getSelectionAsState() { return selection; } /** * Retrieves the state for the given name * * @name a string containing a state name * * @return the matching state or null when none */ protected State getState( String name ) { State found = null; for( int i = 0; i != states.length; ++i ) { if( states[i].getName() .equals(name) ) { found = states[i]; break; } } return found; } /** * Selectes the given state * * @param state a string containing a state name */ protected void selectState( String state ) { State candidate = getState(state); if( candidate != null ) { selection = candidate; dirty = true; fireEditorChanged(); } } } eclox/eclox.ui/src/eclox/ui/editor/basic/RadioMultiEditor.java 0000644 0001750 0000144 00000006247 12166012446 023760 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; public class RadioMultiEditor extends MultiEditor { /** * Implements the selection listener used for radio button */ private class MySelectionListener implements SelectionListener { public void widgetDefaultSelected(SelectionEvent e) { widgetSelected(e); } public void widgetSelected(SelectionEvent e) { Button button = (Button) e.widget; if( button.getSelection() == true ) { selectState( button.getText() ); commit(); } } } /** * an array containing all radio button representing this editor */ private Button[] buttons; /** * Constructor * * @param states an array of string representing the states of the editor */ public RadioMultiEditor( String [] states ) { super( states ); } /** * @see eclox.ui.editor.editors.IEditor#createContent(org.eclipse.swt.widgets.Composite, org.eclipse.ui.forms.widgets.FormToolkit) */ public void createContent(Composite parent, FormToolkit formToolkit) { // Creates all radio buttons. buttons = new Button[states.length]; for( int i = 0; i != states.length; ++i ) { buttons[i] = formToolkit.createButton(parent, states[i].getName(), SWT.RADIO); buttons[i].addSelectionListener( new MySelectionListener() ); } // Installs the layout. parent.setLayout( new FillLayout(SWT.VERTICAL) ); } /** * @see eclox.ui.editor.editors.IEditor#dispose() */ public void dispose() { buttons = null; } /** * @see eclox.ui.editor.editors.IEditor#grabVerticalSpace() */ public boolean grabVerticalSpace() { return false; } /** * @see eclox.ui.editor.basic.MultiEditor#refresh() */ public void refresh() { // Pre-condition assert buttons != null; super.refresh(); // Refreshes managed buttons State selection = getSelectionAsState(); for( int i = 0; i != buttons.length; ++i ) { buttons[i].setSelection( selection != null && selection.getName().equals(buttons[i].getText()) ); } } /** * @see eclox.ui.editor.editors.IEditor#setEnabled(boolean) */ public void setEnabled(boolean enabled) { // Pre-condition assert buttons != null; for( int i = 0; i != buttons.length; ++i ) { buttons[i].setEnabled(enabled); } } /** * @see eclox.ui.editor.editors.IEditor#setFocus() */ public void setFocus() { // Pre-condition assert buttons != null; buttons[0].setFocus(); } } eclox/eclox.ui/src/eclox/ui/editor/basic/DiagramsPart.java 0000644 0001750 0000144 00000012517 12166012446 023113 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; import eclox.core.doxyfiles.Doxyfile; import eclox.ui.editor.editors.CheckBoxEditor; import eclox.ui.editor.editors.IEditor; import eclox.ui.editor.editors.IEditorListener; /** * Implements a art that provides editors for diagram generation controlling. * * @author Guillaume Brocker */ public class DiagramsPart extends Part { /** * Implements an editor listener that will trigger enabled state updates. */ private class MyEditorListener implements IEditorListener { /** * @see eclox.ui.editor.editors.IEditorListener#editorChanged(eclox.ui.editor.editors.IEditor) */ public void editorChanged(IEditor editor) { // Pre-condition assert editor == diagrams; final String selection = diagrams.getSelection(); final boolean enabled = selection != null && selection.equals(DIAGRAM_DOT_TOOL); classGraph .setEnabled(enabled && classGraph.hasInput()); collaborationGraph.setEnabled(enabled && collaborationGraph.hasInput()); includeGraph .setEnabled(enabled && includeGraph.hasInput()); includedByGraph .setEnabled(enabled && includedByGraph.hasInput()); graphicalHierarcy .setEnabled(enabled && graphicalHierarcy.hasInput()); callGraph .setEnabled(enabled && callGraph.hasInput()); } } /** * symbolic constant for diagram activation's state */ private static final String DIAGRAM_NONE = "No diagrams"; /** * symbolic constant for diagram activation's state */ private static final String DIAGRAM_BUILT_IN = "Use built-in diagram generator"; /** * symbolic constant for diagram activation's state */ private static final String DIAGRAM_DOT_TOOL = "Use dot tool from the GraphViz package to generate:"; /** * the editor for diagram activation */ private MultiEditor diagrams = new RadioMultiEditor( new String[] {DIAGRAM_NONE, DIAGRAM_BUILT_IN, DIAGRAM_DOT_TOOL} ); /** * the editor for the dot class graph generation */ private CheckBoxEditor classGraph = new CheckBoxEditor("class diagrams"); /** * the editor for the dot collaboration graph generation */ private CheckBoxEditor collaborationGraph = new CheckBoxEditor("collaboration diagrams"); /** * the editor for the dot include graph generation */ private CheckBoxEditor includeGraph = new CheckBoxEditor("include dependency graph"); /** * the editor for the dot included by graph generation */ private CheckBoxEditor includedByGraph = new CheckBoxEditor("included by dependency graph"); /** * the editor for the dot hierarchy graph generation */ private CheckBoxEditor graphicalHierarcy = new CheckBoxEditor("overall class hierarchy"); /** * the editor for the dot call graph generation */ private CheckBoxEditor callGraph = new CheckBoxEditor("call graphs"); /** * Constructor * * @param parent the parent composite * @param toolkit the toolkit to use for control creations * @param doxyfile the doxyfile being edited */ DiagramsPart( Composite parent, FormToolkit toolkit, Doxyfile doxyfile ) { super( parent, toolkit, "Diagrams to Generate", doxyfile ); // Creates all editors. addEditor( diagrams ); addEditor( classGraph, 16 ); addEditor( collaborationGraph, 16 ); addEditor( includeGraph, 16 ); addEditor( includedByGraph, 16 ); addEditor( graphicalHierarcy, 16 ); addEditor( callGraph, 16 ); // Setup all editors. if( doxyfile.hasSetting("CLASS_DIAGRAMS") && doxyfile.hasSetting("HAVE_DOT") ) { diagrams.addListener(new MyEditorListener()); diagrams.addSetting(DIAGRAM_BUILT_IN, doxyfile.getSetting("CLASS_DIAGRAMS")); diagrams.addSetting(DIAGRAM_DOT_TOOL, doxyfile.getSetting("HAVE_DOT")); classGraph .setInput(doxyfile.getSetting("CLASS_GRAPH")); collaborationGraph.setInput(doxyfile.getSetting("COLLABORATION_GRAPH")); includeGraph .setInput(doxyfile.getSetting("INCLUDE_GRAPH")); includedByGraph .setInput(doxyfile.getSetting("INCLUDED_BY_GRAPH")); graphicalHierarcy .setInput(doxyfile.getSetting("GRAPHICAL_HIERARCHY")); callGraph .setInput(doxyfile.getSetting("CALL_GRAPH")); classGraph .setEnabled(classGraph.hasInput()); collaborationGraph.setEnabled(collaborationGraph.hasInput()); includeGraph .setEnabled(includeGraph.hasInput()); includedByGraph .setEnabled(includedByGraph.hasInput()); graphicalHierarcy .setEnabled(graphicalHierarcy.hasInput()); callGraph .setEnabled(callGraph.hasInput()); } else { diagrams .setEnabled(false); classGraph .setEnabled(false); collaborationGraph.setEnabled(false); includeGraph .setEnabled(false); includedByGraph .setEnabled(false); graphicalHierarcy .setEnabled(false); callGraph .setEnabled(false); } } } eclox/eclox.ui/src/eclox/ui/editor/basic/OutputPart.java 0000644 0001750 0000144 00000011136 12166012446 022660 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor.basic; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.forms.widgets.FormToolkit; import eclox.core.doxyfiles.Doxyfile; import eclox.ui.editor.editors.CheckBoxEditor; import eclox.ui.editor.editors.IEditor; import eclox.ui.editor.editors.IEditorListener; public class OutputPart extends Part { /** * Implements an editor listener that will update * enabled states of some editors according to the value * of some other editors. */ private class MyEditorListener implements IEditorListener { /** * @see eclox.ui.editor.editors.IEditorListener#editorDirtyChanged(eclox.ui.editor.editors.IEditor) */ public void editorChanged(IEditor editor) { if( editor == html ) { htmlFlavour.setEnabled( ((CheckBoxEditor)editor).getValue() ); htmlSearchEngine.setEnabled( ((CheckBoxEditor)editor).getValue() ); } else if( editor == latex ) { latexFlavour.setEnabled( ((CheckBoxEditor)editor).getValue() ); } } } /** * html flavour state */ private static final String PLAIN_HTML = "plain HTML"; /** * html flavour state */ private static final String FRAME_HTML = "with frames and navigation tree"; /** * html flavour state */ private static final String CHM_HTML = "prepared for compressed HTML (.chm)"; /** * latex flavour for hyperlinked pdf state */ private static final String LATEX_HYPEDLINKED_PDF = "as itermediate format for hypedlinked PDF"; /** * latex flavour for pdf state */ private static final String LATEX_PDF = "as itermediate format for PDF"; /** * latex flavour for PostScript state */ private static final String LATEX_POSTSCRIPT = "as itermediate format for PostScript"; /** * html editor */ CheckBoxEditor html = new CheckBoxEditor("HTML"); /** * html flavour editor */ RadioMultiEditor htmlFlavour = new RadioMultiEditor( new String[] {PLAIN_HTML, FRAME_HTML, CHM_HTML} ); /** * html search engine editor */ CheckBoxEditor htmlSearchEngine = new CheckBoxEditor( "with search function (requires PHP enabled server)" ); /** * latex editor */ CheckBoxEditor latex = new CheckBoxEditor("LaTeX"); /** * latex flavour editor */ RadioMultiEditor latexFlavour = new RadioMultiEditor( new String[] {LATEX_HYPEDLINKED_PDF, LATEX_PDF, LATEX_POSTSCRIPT} ); CheckBoxEditor man = new CheckBoxEditor("Man Pages"); CheckBoxEditor rtf = new CheckBoxEditor("Rich Text Format"); CheckBoxEditor xml = new CheckBoxEditor("XML"); public OutputPart( Composite parent, FormToolkit toolkit, Doxyfile doxyfile ) { super( parent, toolkit, "Output Formats", doxyfile ); addEditor( html ); addEditor( htmlFlavour, 16 ); addEditor( htmlSearchEngine, 16 ); addEditor( latex ); addEditor( latexFlavour, 16 ); addEditor( man ); addEditor( rtf ); addEditor( xml ); if( doxyfile.hasSetting("GENERATE_HTML") ) { html.addListener(new MyEditorListener()); html.setInput( doxyfile.getSetting("GENERATE_HTML") ); htmlFlavour.addSetting(FRAME_HTML, doxyfile.getSetting("GENERATE_TREEVIEW") ); htmlFlavour.addSetting(CHM_HTML, doxyfile.getSetting("GENERATE_HTMLHELP") ); htmlSearchEngine.setInput( doxyfile.getSetting("SEARCHENGINE") ); } else { html.setEnabled(false); htmlFlavour.setEnabled(false); htmlSearchEngine.setEnabled(false); } if( doxyfile.hasSetting("GENERATE_LATEX") ) { latex.addListener(new MyEditorListener()); latex.setInput( doxyfile.getSetting("GENERATE_LATEX") ); latexFlavour.addSetting(LATEX_HYPEDLINKED_PDF, doxyfile.getSetting("PDF_HYPERLINKS") ); latexFlavour.addSetting(LATEX_HYPEDLINKED_PDF, doxyfile.getSetting("USE_PDFLATEX") ); latexFlavour.addSetting(LATEX_PDF, doxyfile.getSetting("USE_PDFLATEX") ); } else { latex.setEnabled(false); latexFlavour.setEnabled(false); } man.setInput( doxyfile.getSetting("GENERATE_MAN") ); man.setEnabled( man.hasInput() ); rtf.setInput( doxyfile.getSetting("GENERATE_RTF") ); rtf.setEnabled( rtf.hasInput() ); xml.setInput( doxyfile.getSetting("GENERATE_XML") ); xml.setEnabled( xml.hasInput() ); } } eclox/eclox.ui/src/eclox/ui/editor/SourcePage.java 0000644 0001750 0000144 00000001734 12166012446 021510 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2004, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor; import org.eclipse.ui.forms.editor.FormPage; /** * @author gbrocker */ public class SourcePage extends FormPage { /** * Defines the source page identifer. */ public static final String ID = "source"; /** * Constructor. * * @param editor the editor instance to attach to */ public SourcePage(Editor editor) { super(editor, ID, "Sources"); } } eclox/eclox.ui/src/eclox/ui/editor/Location.java 0000644 0001750 0000144 00000003143 12166012446 021217 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.editor; import org.eclipse.ui.IMemento; import org.eclipse.ui.INavigationLocation; import org.eclipse.ui.NavigationLocation; /** * Implements the navigation location used for the doxyfile editor. * * @author Guillaume Brocker */ public class Location extends NavigationLocation { private final String PAGE_KEY = "page"; private final String SETTING_KEY = "setting"; private String page; private String setting; public Location( Editor editor ) { super( editor ); this.page = editor.getActivePageInstance().getId(); } public boolean mergeInto(INavigationLocation currentLocation) { // TODO Auto-generated method stub return false; } public void restoreLocation() { // TODO Auto-generated method stub } public void restoreState(IMemento memento) { page = memento.getString(PAGE_KEY); setting = memento.getString(SETTING_KEY); } public void saveState(IMemento memento) { memento.putString(PAGE_KEY, page); memento.putString(SETTING_KEY, setting); } public void update() { // TODO Auto-generated method stub } } eclox/eclox.ui/src/eclox/ui/DoxyfileSelector.java 0000644 0001750 0000144 00000024573 12166012446 021457 0 ustar willy users /******************************************************************************* * Copyright (C) 2003, 2004, 2007, 2008, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui; import java.util.ArrayList; import java.util.Collection; import java.util.HashSet; import java.util.Iterator; import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.Status; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.viewers.ITreeContentProvider; import org.eclipse.jface.viewers.LabelProvider; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.Viewer; import org.eclipse.swt.graphics.Image; import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.PlatformUI; import org.eclipse.ui.dialogs.ElementTreeSelectionDialog; import org.eclipse.ui.dialogs.ISelectionStatusValidator; import org.eclipse.ui.model.IWorkbenchAdapter; import eclox.core.Plugin; import eclox.core.doxyfiles.ResourceCollector; /** * Allow the user to choose one doxyfile among a list. * * @author gbrocker */ public class DoxyfileSelector { /** * Implement the tree content provider for the dialog. */ private static class MyContentProvider implements ITreeContentProvider { /** * The doxyfile collection. */ private Collection m_input = null; /** * Disposes of this content provider. This is called by the viewer when it is disposed. */ public void dispose() {} /** * Notifies this content provider that the given viewer's input has been switched to a different element. */ public void inputChanged(Viewer viewer, Object oldInput, Object newInput) { m_input = (Collection) newInput; } /** * Returns the child elements of the given parent element. * * @param parentElement the parent element * * @return an array of child elements */ public Object[] getChildren(Object parentElement) { Collection children = new ArrayList(); Iterator doxyfileIt = m_input.iterator(); while(doxyfileIt.hasNext()) { IFile doxyfile = (IFile) doxyfileIt.next(); if(doxyfile.getProject() == parentElement) { children.add(doxyfile); } } return children.toArray(); } /** * Returns the elements to display in the viewer when its input is set to the given element. These elements can be presented as rows in a table, items in a list, etc. The result is not modified by the viewer. * * @param inputElement the input element * * @return the array of elements to display in the viewer */ public Object[] getElements(Object inputElement) { Collection doxyfiles = (Collection) inputElement; Object[] result = null; if(doxyfiles != null) { Collection projects = new HashSet(); Iterator doxyfileIt = doxyfiles.iterator(); while(doxyfileIt.hasNext() == true) { IFile doxyfile = (IFile) doxyfileIt.next(); projects.add(doxyfile.getProject()); } result = projects.toArray(); } else { result = new Object[0]; } return result; } /** * Returns the parent for the given element, or null indicating that the parent can't be computed. * * In this case the tree-structured viewer can't expand a given node correctly if requested. * * @param element the element * * @return the parent element, or null if it has none or if the parent cannot be computed. */ public Object getParent(Object element) { Object result = null; if(element instanceof IProject) { return null; } else if(element instanceof IFile) { return ((IFile)element).getProject(); } return result; } /** * Returns whether the given element has children. * * Intended as an optimization for when the viewer does not need the actual children. Clients may be able to implement this more efficiently than getChildren. * * @param element the element * * @return true if the given element has children, and false if it has no children */ public boolean hasChildren(Object element) { return element instanceof IProject; } } /** * Implement a label provider for the doxyfile selector tree viewer. */ private static class MyLabelProvider extends LabelProvider { /** * Returns the image for the label of the given element. * The image is owned by the label provider and must not be disposed directly. * Instead, dispose the label provider when no longer needed. * * @param element the element for which to provide the label image * * @return the image used to label the element, * or null if there is no image for the given object */ public Image getImage(Object element) { // Pre-condition. assert element instanceof IResource; Image result = null; IResource resourse = (IResource) element; IWorkbenchAdapter workbenchAdapter = (IWorkbenchAdapter) resourse.getAdapter( IWorkbenchAdapter.class ); if( workbenchAdapter != null ) { result = workbenchAdapter.getImageDescriptor( element ).createImage(); } return result; } /** * The LabelProvider implementation of this ILabelProvider method returns * the element's toString string. Subclasses may override. * * @param element the element for which to provide the label text * * @return the text string used to label the element, * or null if there is no text label for the given object */ public String getText(Object element) { // Pre-condition. assert element instanceof IResource; String result = null; IResource resourse = (IResource) element; IWorkbenchAdapter workbenchAdapter = (IWorkbenchAdapter) resourse.getAdapter( IWorkbenchAdapter.class ); if( workbenchAdapter != null ) { result = workbenchAdapter.getLabel( element ); } return result; } } /** * Implement a doxyfile selection validator. */ private static class MySelectionValidator implements ISelectionStatusValidator { /** * Validates an array of elements and returns the resulting status. * * @param selection The elements to validate * * @return The resulting status */ public IStatus validate(Object[] selection) { IStatus result = null; if(selection.length == 1 && selection[0] instanceof IFile) { result = new Status( Status.OK, Plugin.getDefault().getBundle().getSymbolicName(), 0, "", null ); } else { result = new Status( Status.ERROR, Plugin.getDefault().getBundle().getSymbolicName(), 0, "You must choose a Doxyfile to build.", null); } return result; } } private boolean hadDoxyfiles = false; ///< Tells if there were doxyfiles for selection. private IFile doxyfile = null; ///< The selected doxyfile private IResource root = null; ///< The root resource that is that will be starting point for doxyfiles search. /** * @param root the root resource to search for doxyfiles, the workspace root if null */ public DoxyfileSelector( IResource rootResource ) { this.root = rootResource; } /** * Opens the selection dialog and tells if the user validated to selection. * * @return true when a selection was made, false otherwise. */ public boolean open() { Shell shell = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell(); ISelection selection = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getSelectionService().getSelection(); IStructuredSelection structuredSelection = (selection != null && selection instanceof IStructuredSelection) ? (IStructuredSelection) selection : new StructuredSelection(); boolean result = false; try { ResourceCollector collector = root != null ? ResourceCollector.run(root) : ResourceCollector.run(); hadDoxyfiles = collector.isEmpty() == false; if( collector.isEmpty() == false ) { ElementTreeSelectionDialog selectionDialog = new ElementTreeSelectionDialog(shell, new MyLabelProvider(), new MyContentProvider()); selectionDialog.setAllowMultiple( false ); selectionDialog.setInput( collector.getDoxyfiles() ); selectionDialog.setValidator( new MySelectionValidator() ); selectionDialog.setEmptyListMessage( "No Doxyfile found in opened projects." ); selectionDialog.setMessage( "Select a Doxyfile:" ); selectionDialog.setTitle( "Doxyfile Selection" ); selectionDialog.setInitialSelections( structuredSelection.toArray() ); // Opens the selection dialog and save the selection. if( selectionDialog.open() == ElementTreeSelectionDialog.OK ) { doxyfile = (IFile) selectionDialog.getFirstResult(); result = true; } } } catch( Throwable t ) { eclox.ui.Plugin.log(t); } return result; } /** * Convenient method that prompts the user to select a doxyfile. * * @param root The root resource to search for doxyfiles * * @return the selected doxyfile, null otherwise */ public static IFile open( IResource root ) { DoxyfileSelector selector = new DoxyfileSelector(root); selector.open(); return selector.getDoxyfile(); } /** * @brief Asks the user for a doxyfile. * * @return a doxyfile, null if none has been choosen */ public IFile getDoxyfile() { return doxyfile; } /** * @brief Tells if there were doxyfiles for last selection. * * @return true or false */ public boolean hadDoxyfiles() { return hadDoxyfiles; } } eclox/eclox.ui/src/eclox/ui/Plugin.java 0000644 0001750 0000144 00000010330 12166012446 017413 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2008, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui; import org.eclipse.core.runtime.Status; import org.eclipse.core.runtime.jobs.Job; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.resource.ImageDescriptor; import org.eclipse.jface.window.Window; import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.dialogs.PreferencesUtil; import org.eclipse.ui.plugin.AbstractUIPlugin; import org.osgi.framework.BundleContext; /** * The plugin class. */ /** * @author gbrocker * */ public class Plugin extends AbstractUIPlugin { private static Plugin plugin; ///< The singleton instance. private BuildManager buildManager; ///< The managed build manager. private JobMonitor jobMonitor; ///< The managed job monitor. /** * Asks the user if he wants to edit doxygen configuration after a failed * doxygen invocation. * * @return @c true if doxygen configuration has been edited, @c false otherwise */ public static boolean editPreferencesAfterDoxygenInvocationFailed() { Shell shell = plugin.getWorkbench().getActiveWorkbenchWindow().getShell(); // Asks the user if he wants to edit the preferences to solve the problem. boolean editionWanted = MessageDialog.openQuestion(shell, "Doxygen Not Found", "Eclox was not able to run doxygen. Doxygen is either missing or eclox is not properly configured to use it.\n\nWould you like to edit preferences now ?" ); if( ! editionWanted ) { return false; } // Allows the user to edit the preferences and eventually launch doxygen again. String[] filter = { eclox.core.ui.PreferencePage.ID }; int edited = PreferencesUtil.createPreferenceDialogOn(shell, eclox.core.ui.PreferencePage.ID, filter, null).open(); return edited == Window.OK; } /** * The constructor. */ public Plugin() { plugin = this; } /** * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext) */ public void start(BundleContext context) throws Exception { super.start(context); buildManager = new BuildManager(); buildManager.restoreState(); jobMonitor = new JobMonitor(); Job.getJobManager().addJobChangeListener(jobMonitor); } /** * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext) */ public void stop(BundleContext context) throws Exception { buildManager.saveState(); buildManager = null; Job.getJobManager().removeJobChangeListener(jobMonitor); jobMonitor = null; plugin = null; super.stop(context); } /** * Returns the shared instance. */ public static Plugin getDefault() { return plugin; } /** * Retrieves the build manager of the plugin. * * @return the managed build manager instance */ public BuildManager getBuildManager() { return buildManager; } /** * Adds the specified throwable object into the plugin's log as an error. * * @param throwable a throwable instance to log */ public static void log( Throwable throwable ) { plugin.getLog().log( new Status(Status.ERROR, plugin.getBundle().getSymbolicName(), 0, "Exception caught. " + throwable.toString(), throwable) ); } /** * Adds the specified message into the plugin's log as an error. * * @param message a string containing a message to log. */ public static void log( String message ) { plugin.getLog().log( new Status(Status.ERROR, plugin.getBundle().getSymbolicName(), 0, "Error encountered. " + message, null) ); } /** * Returns an image descriptor for the image file at the given * plug-in relative path. * * @param path the path * @return the image descriptor */ public static ImageDescriptor getImageDescriptor(String path) { return AbstractUIPlugin.imageDescriptorFromPlugin( plugin.getBundle().getSymbolicName(), path); } } eclox/eclox.ui/src/eclox/ui/console/ 0000755 0001750 0000144 00000000000 12315037715 016761 5 ustar willy users eclox/eclox.ui/src/eclox/ui/console/ConsolePage.java 0000644 0001750 0000144 00000016162 12166012446 022027 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013 Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.console; import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.jobs.IJobChangeEvent; import org.eclipse.core.runtime.jobs.IJobChangeListener; import org.eclipse.core.runtime.jobs.Job; import org.eclipse.jface.resource.JFaceResources; import org.eclipse.swt.SWT; import org.eclipse.swt.custom.StyledText; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.ui.IActionBars; import org.eclipse.ui.console.ConsolePlugin; import org.eclipse.ui.console.IConsoleConstants; import org.eclipse.ui.part.Page; import eclox.core.doxygen.BuildJob; import eclox.core.doxygen.IBuildJobListener; import eclox.ui.console.action.CancelJob; import eclox.ui.console.action.ClearLog; import eclox.ui.console.action.LockScroll; import eclox.ui.console.action.RemoveConsole; /** * Implements the page for the doxygen console. * * @author gbrocker */ public class ConsolePage extends Page { /** * Implements a build job listener that will maintain the console up-to-date * with the job log. * * @author gbrocker */ private class MyBuildJobListener implements IBuildJobListener { /** * @see eclox.core.doxygen.IBuildJobListener#buildJobLogCleared(eclox.core.doxygen.BuildJob) */ public void buildJobLogCleared(BuildJob job) { ConsolePlugin.getStandardDisplay().asyncExec( new Runnable() { public void run() { clear(); } } ); } /** * @see eclox.core.doxygen.IBuildJobListener#buildJobLogUpdated(eclox.core.doxygen.BuildJob, java.lang.String) */ public void buildJobLogUpdated(BuildJob job, String output) { final String text = new String( output ); ConsolePlugin.getStandardDisplay().asyncExec( new Runnable() { public void run() { append( text ); } } ); } /** * @see eclox.core.doxygen.IBuildJobListener#buildJobRemoved(eclox.core.doxygen.BuildJob) */ public void buildJobRemoved(BuildJob job) {} } /** * @brief Implements a job change listener used to update the interface state according to the * build job events. * * @author gbrocker */ private class MyJobChangedListener implements IJobChangeListener { public void aboutToRun(IJobChangeEvent event) { ConsolePlugin.getStandardDisplay().syncExec( new Runnable() { public void run() { updateActionStates(); } } ); } public void awake(IJobChangeEvent event) {} public void done(final IJobChangeEvent event) { ConsolePlugin.getStandardDisplay().syncExec( new Runnable() { public void run() { updateActionStates(); IStatus status = event.getResult(); if( status.isOK() ) { append( "*** Build finished!" ); } else { append( "*** Build aborted! " ); append( status.getMessage() ); } } } ); } public void running(IJobChangeEvent event) {} public void scheduled(IJobChangeEvent event) {} public void sleeping(IJobChangeEvent event) {} } private boolean scrollLocked = false; ///< a boolean telling if the console scrolling is locked or not private StyledText styledText; ///< the control used to display text private Console console; ///< the console the page is attached to private CancelJob cancelJobAction; ///< the action that cancels the build job private MyBuildJobListener jobListener; ///< the build job listener private MyJobChangedListener jobChangedListener; ///< the build job change listener /** * Constructor * * @param console the console the page is attached to */ public ConsolePage( Console console ) { this.console = console; } /** * Appends text to the console. * * @param text a string containing the text to append */ private void append( String text ) { assert styledText != null; styledText.append( text ); scroll(); } /** * Clears the console content. */ private void clear() { assert styledText != null; styledText.setText( new String() ); } /** * @see org.eclipse.ui.part.Page#dispose() */ public void dispose() { // Removes job listeners. console.getJob().removeBuidJobListener(jobListener); console.getJob().removeJobChangeListener(jobChangedListener); // Release some references. console = null; styledText = null; cancelJobAction = null; // Base treatment. super.dispose(); } /** * @see org.eclipse.ui.part.Page#createControl(org.eclipse.swt.widgets.Composite) */ public void createControl(Composite parent) { assert console != null; assert styledText == null; assert cancelJobAction == null; // Creates the text control. styledText = new StyledText( parent, SWT.READ_ONLY|SWT.MULTI|SWT.H_SCROLL|SWT.V_SCROLL ); styledText.setFont( JFaceResources.getTextFont() ); // Creates the cancel job action. cancelJobAction = new CancelJob( console ); // Creates job listeners; jobListener = new MyBuildJobListener(); jobChangedListener = new MyJobChangedListener(); console.getJob().addBuidJobListener(jobListener); console.getJob().addJobChangeListener(jobChangedListener); // Creates the actions IActionBars actionBars = getSite().getActionBars(); actionBars.getToolBarManager().appendToGroup( IConsoleConstants.LAUNCH_GROUP, cancelJobAction ); actionBars.getToolBarManager().appendToGroup( IConsoleConstants.LAUNCH_GROUP, new RemoveConsole(console) ); actionBars.getToolBarManager().appendToGroup( IConsoleConstants.OUTPUT_GROUP, new ClearLog(console) ); actionBars.getToolBarManager().appendToGroup( IConsoleConstants.OUTPUT_GROUP, new LockScroll(this) ); actionBars.updateActionBars(); } /** * @see org.eclipse.ui.part.Page#getControl() */ public Control getControl() { return styledText; } /** * Scrolls the console to the end of the log */ private void scroll() { assert styledText != null; if( scrollLocked == false ) { styledText.setSelection( styledText.getCharCount() ); styledText.showSelection(); } } /** * @see org.eclipse.ui.part.Page#setFocus() */ public void setFocus() { assert styledText != null; styledText.setFocus(); } /** * Updates the lock of the console scroll. * * @param locked a boolean giving the new lock state */ public void setScrollLocked( boolean locked ) { scrollLocked = locked; } /** * Updates the state of some action according to the current job's state */ private void updateActionStates() { assert cancelJobAction != null; assert console != null; BuildJob job = console.getJob(); cancelJobAction.setEnabled( job != null && job.getState() == Job.RUNNING ); } } eclox/eclox.ui/src/eclox/ui/console/Console.java 0000644 0001750 0000144 00000007360 12166012446 021232 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013 Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.console; import java.util.HashMap; import java.util.Map; import org.eclipse.ui.console.AbstractConsole; import org.eclipse.ui.console.ConsolePlugin; import org.eclipse.ui.console.IConsole; import org.eclipse.ui.console.IConsoleManager; import org.eclipse.ui.console.IConsoleView; import org.eclipse.ui.part.IPageBookViewPage; import eclox.core.doxygen.BuildJob; import eclox.core.doxygen.IBuildJobListener; /** * Implements the doxygen output console * * @author Guillaume Brocker */ public class Console extends AbstractConsole { /** * @brief Implements a build job listener. */ private class MyBuildJobListener implements IBuildJobListener { /** * @see eclox.core.doxygen.IBuildJobListener#buildJobLogCleared(eclox.core.doxygen.BuildJob) */ public void buildJobLogCleared(BuildJob job) {} /** * @see eclox.core.doxygen.IBuildJobListener#buildJobLogUpdated(eclox.core.doxygen.BuildJob, java.lang.String) */ public void buildJobLogUpdated(BuildJob job, String output) {} /** * @see eclox.core.doxygen.IBuildJobListener#buildJobRemoved(eclox.core.doxygen.BuildJob) */ public void buildJobRemoved(BuildJob job) { final BuildJob localJob = job; ConsolePlugin.getStandardDisplay().asyncExec( new Runnable() { public void run() { remove(localJob); } } ); } } private static Map consoles = new HashMap(); ///< Holds all known console instances. private BuildJob job; ///< the build job /** * Constructor * * @param job the build job whose output must be shown */ private Console(BuildJob job) { super( job.getName(), null ); this.job = job; this.job.addBuidJobListener(new MyBuildJobListener()); } /** * @see org.eclipse.ui.console.IConsole#createPage(org.eclipse.ui.console.IConsoleView) */ public IPageBookViewPage createPage(IConsoleView view) { return new ConsolePage(this); } /** * @see org.eclipse.ui.console.AbstractConsole#dispose() */ protected void dispose() { consoles.remove(job); super.dispose(); } /** * @see org.eclipse.ui.console.AbstractConsole#init() */ protected void init() { consoles.put(job, this); super.init(); } /** * Retrieves the job currently monitored by the console * * @return a build job or null if none */ public BuildJob getJob() { return job; } /** * Shows a console for the given job. * * @param job a build that needs a console to be shown */ static public void show( BuildJob job ) { // Retrieves the active workbench window and console manager. IConsoleManager consoleManager = ConsolePlugin.getDefault().getConsoleManager(); Console console = null; if( consoles.containsKey(job) ) { console = (Console) consoles.get(job); } else { console = new Console(job); consoleManager.addConsoles( new IConsole[] {console} ); } // Shows the console view. console.activate(); } /** * Removes the console for the given build job. * * @param job a build job */ public static void remove(BuildJob job) { if( consoles.containsKey(job) ) { Console console = (Console) consoles.get(job); ConsolePlugin.getDefault().getConsoleManager().removeConsoles( new IConsole[] {console} ); } } } eclox/eclox.ui/src/eclox/ui/console/action/ 0000755 0001750 0000144 00000000000 12315037715 020236 5 ustar willy users eclox/eclox.ui/src/eclox/ui/console/action/LockScroll.java 0000644 0001750 0000144 00000002521 12166012446 023146 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.console.action; import org.eclipse.jface.action.Action; import eclox.ui.Images; import eclox.ui.Plugin; import eclox.ui.console.ConsolePage; /** * Implements the action that will lock the console from scrolling while output * is appended to the log. * * @author gbrocker */ public class LockScroll extends Action { /** * the console page to act on */ private ConsolePage consolePage; /** * Constructor * * @param consolePage the console to act on */ public LockScroll( ConsolePage consolePage ) { super("Scroll Lock", AS_CHECK_BOX); this.consolePage = consolePage; setImageDescriptor( Plugin.getImageDescriptor(Images.LOCK_CONSOLE) ); setToolTipText( "Scroll Lock" ); } public void run() { consolePage.setScrollLocked( isChecked() ); super.run(); } } eclox/eclox.ui/src/eclox/ui/console/action/CancelJob.java 0000644 0001750 0000144 00000002363 12166012446 022723 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2006, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.console.action; import org.eclipse.jface.action.Action; import eclox.ui.Images; import eclox.ui.Plugin; import eclox.ui.console.Console; /** * Implements an action that will cancel the current build job of the console. * * @author gbrocker */ public class CancelJob extends Action { /** * the console the action is attached to */ Console console; /** * Constructor * * @param console the build console */ public CancelJob( Console console ) { super( "Terminate", Plugin.getImageDescriptor(Images.TERMINATE) ); this.console = console; setToolTipText( "Terminate Build" ); setEnabled( false ); } public void run() { console.getJob().cancel(); super.run(); } } eclox/eclox.ui/src/eclox/ui/console/action/RemoveConsole.java 0000644 0001750 0000144 00000002542 12166012446 023662 0 ustar willy users /******************************************************************************* * Copyright (C) 2007, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.console.action; import org.eclipse.jface.action.Action; import org.eclipse.ui.console.ConsolePlugin; import org.eclipse.ui.console.IConsole; import eclox.ui.Images; import eclox.ui.Plugin; import eclox.ui.console.Console; /** * Implements an action that removes a given console. * * @author gbrocker */ public class RemoveConsole extends Action { /** * the console the action is attached to */ Console console; /** * Constructor * * @param console the build console */ public RemoveConsole( Console console ) { super( "Remove", Plugin.getImageDescriptor(Images.REMOVE) ); this.console = console; setToolTipText( "Remove Doxygen Build Console" ); } public void run() { ConsolePlugin.getDefault().getConsoleManager().removeConsoles( new IConsole[] {console} ); super.run(); } } eclox/eclox.ui/src/eclox/ui/console/action/ClearLog.java 0000644 0001750 0000144 00000002313 12166012446 022566 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2006, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.console.action; import org.eclipse.jface.action.Action; import eclox.core.doxygen.BuildJob; import eclox.ui.Images; import eclox.ui.Plugin; import eclox.ui.console.Console; public class ClearLog extends Action { /** * the console to act on */ private Console console; /** * Constructor * * @param console the console to act on */ public ClearLog( Console console ) { super( "Clear Console", Plugin.getImageDescriptor(Images.CLEAR_CONSOLE) ); this.console = console; setToolTipText( "Clear Build Log" ); } public void run() { BuildJob job = console.getJob(); if( job != null ) { job.clearLog(); } super.run(); } } eclox/eclox.ui/src/eclox/ui/action/ 0000755 0001750 0000144 00000000000 12315037715 016574 5 ustar willy users eclox/eclox.ui/src/eclox/ui/action/BuildActionDelegate.java 0000644 0001750 0000144 00000022560 12166012446 023272 0 ustar willy users /******************************************************************************* * Copyright (C) 2003, 2004, 2007, 2008, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.action; import org.eclipse.core.resources.IFile; import org.eclipse.jface.action.IAction; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.wizard.WizardDialog; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Menu; import org.eclipse.swt.widgets.MenuItem; import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.IEditorInput; import org.eclipse.ui.IEditorPart; import org.eclipse.ui.IFileEditorInput; import org.eclipse.ui.IWorkbenchPage; import org.eclipse.ui.IWorkbenchWindow; import org.eclipse.ui.IWorkbenchWindowPulldownDelegate; import org.eclipse.ui.PlatformUI; import eclox.core.doxyfiles.Doxyfile; import eclox.core.doxygen.BuildJob; import eclox.ui.DoxyfileSelector; import eclox.ui.Plugin; import eclox.ui.wizard.NewDoxyfileWizard; /** * Implement the action handling for the build action. * * @author gbrocker */ public class BuildActionDelegate implements IWorkbenchWindowPulldownDelegate { /** * Listens for the popup menu items pointing to doxyfiles to build. * * @author Guillaume Brocker */ private class MenuSelectionListener implements SelectionListener { public void widgetSelected(SelectionEvent e) { processData(e.widget.getData()); } public void widgetDefaultSelected(SelectionEvent e) { processData(e.widget.getData()); } private void processData(Object data) { boolean forceChoose = false; if(data != null && data instanceof IFile) { nextDoxyfile = (IFile) data; forceChoose = false; } else { forceChoose = true; } doRun(forceChoose); } } private Menu menu; ///< The managed contextual menu. private IFile nextDoxyfile; ///< Rembers the next doxyfile to build. private IWorkbenchWindow window; ///< Holds the reference to the workbench window where the action takes place. /** * @see org.eclipse.ui.IWorkbenchWindowPulldownDelegate#getMenu(org.eclipse.swt.widgets.Control) */ public Menu getMenu(Control parent) { disposeMenu(); this.menu = new Menu(parent); // Fill it up with the build history items. BuildJob[] buildJobs = Plugin.getDefault().getBuildManager().getRecentBuildJobs(); for( int i = buildJobs.length - 1; i >= 0; i-- ) { MenuItem menuItem = new MenuItem(this.menu, SWT.PUSH); IFile currentDoxyfile = buildJobs[i].getDoxyfile(); menuItem.addSelectionListener( new MenuSelectionListener() ); menuItem.setData( currentDoxyfile ); menuItem.setText( currentDoxyfile.getName() + " [" + currentDoxyfile.getFullPath().toString() + "]" ); } // Add some sugar in the ui if( buildJobs.length > 0 ) { new MenuItem(this.menu, SWT.SEPARATOR); } // Add the fall-back menu item to let the user choose another doxyfile. MenuItem chooseMenuItem = new MenuItem(this.menu, SWT.PUSH); chooseMenuItem.addSelectionListener(new MenuSelectionListener()); chooseMenuItem.setText("Choose Doxyfile..."); // Job's done. return this.menu; } /** * Dispose the delegate. */ public void dispose() { // Frees all resources and references. disposeMenu(); nextDoxyfile = null; window = null; } /** * @see org.eclipse.ui.IWorkbenchWindowActionDelegate#init(org.eclipse.ui.IWorkbenchWindow) */ public void init(IWorkbenchWindow window) { this.window = window; } /** * @see org.eclipse.ui.IActionDelegate#run(org.eclipse.jface.action.IAction) */ public void run(IAction action) { try { doRun(false); } catch( Throwable throwable ) { MessageDialog.openError(window.getShell(), "Unexpected Error", throwable.toString()); } } /** * @see org.eclipse.ui.IActionDelegate#selectionChanged(org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelection) */ public void selectionChanged(IAction action, ISelection selection) { try { // Retrieve the next doxyfile to build from the current selection. nextDoxyfile = getDoxyfileFromSelection(selection); // Retrieve the next doxyfile from the current editor. if( nextDoxyfile == null ) { nextDoxyfile = getDoxyfileFromActiveEditor(window); } // If there is no next doxyfile to build and the history is not empty // set the first history element as the next doxyfile. if( nextDoxyfile == null ) { BuildJob[] buildJobs = Plugin.getDefault().getBuildManager().getRecentBuildJobs(); int buildJobsCount = buildJobs.length; if( buildJobsCount > 0 ) { nextDoxyfile = buildJobs[buildJobsCount - 1].getDoxyfile(); } } // Check the existence of the doxyfile. if( nextDoxyfile != null && nextDoxyfile.exists() == false ) { nextDoxyfile = null; } // Update the tooltip. String tooltipText = nextDoxyfile != null ? "Build " + nextDoxyfile.getFullPath().toString() : "Choose Next Doxyfile"; action.setToolTipText(tooltipText); } catch(Throwable throwable) { MessageDialog.openError(window.getShell(), "Unexpected Error", throwable.toString()); } } /** * Uses the next doxyfile specified to determine what to do. * * @param forceChoose @c true to ask the user for a doxyfile to build. */ protected void doRun(boolean forceChoose) { try { IFile doxyfile = (forceChoose == true) ? null : this.nextDoxyfile; DoxyfileSelector selector = new DoxyfileSelector(null); // If there is no next doxyfile to build, ask the user for one. if(doxyfile == null) { selector.open(); doxyfile = selector.getDoxyfile(); } // If there is no doxyfile, // we will prompt the user to create one and then edit it. if (doxyfile == null && selector.hadDoxyfiles() == false) { doxyfile = askUserToCreateDoxyfile(); } else if (doxyfile != null) { Plugin.getDefault().getBuildManager().build( doxyfile ); } } catch( Throwable throwable ) { MessageDialog.openError(window.getShell(), "Unexpected Error", throwable.toString()); } } /** * Dispose the owned menu. */ private void disposeMenu() { if(this.menu != null) { this.menu.dispose(); this.menu = null; } } /** * Retrieves a doxyfile from the active editor. * * @param window a reference to a workbench window * * @return a doxfile retrieved from the active editor input. */ private static IFile getDoxyfileFromActiveEditor( IWorkbenchWindow window ) { IFile doxyfile = null; IWorkbenchPage activePage = window.getActivePage(); IEditorPart activeEditorPart = activePage != null ? window.getActivePage().getActiveEditor() : null; if(activeEditorPart != null) { IEditorInput activeEditorInput = activeEditorPart.getEditorInput(); if(activeEditorInput instanceof IFileEditorInput) { IFileEditorInput fileEditorInput = (IFileEditorInput)activeEditorInput; IFile file = fileEditorInput.getFile(); if(Doxyfile.isDoxyfile(file) == true) { doxyfile = file; } } } return doxyfile; } /** * Retrieves a doxyfile from the specified selection. * * @return a doxyfile retrieved from the specified selection. */ private static IFile getDoxyfileFromSelection(ISelection selection) { IFile doxyfile = null; // Test if the current selection is not empty. if(selection instanceof IStructuredSelection && selection.isEmpty() == false) { IStructuredSelection structSel = (IStructuredSelection) selection; Object element = structSel.getFirstElement(); if(element != null && element instanceof IFile) { IFile fileElement = (IFile) element; if(fileElement.exists() == true && Doxyfile.isDoxyfile(fileElement) == true) { doxyfile = fileElement; } } } // Job's done. return doxyfile; } /** * Prompts the user to create a new doxyfile. * * @return a doxyfile, or null if none. */ private static IFile askUserToCreateDoxyfile() { IFile doxyfile = null; Shell shell = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell(); boolean wantDoxyfile = MessageDialog.openQuestion(shell, "No Doxyfile Found", "No doxyfile has been found in opened projects.\n\nDo you want to create a new doxyfile now ?" ); if( wantDoxyfile ) { NewDoxyfileWizard wizard = new NewDoxyfileWizard(); ISelection selection = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getSelectionService().getSelection(); IStructuredSelection strcSelection = (selection != null && selection instanceof IStructuredSelection) ? (IStructuredSelection) selection : new StructuredSelection(); wizard.init(PlatformUI.getWorkbench(), strcSelection); WizardDialog wizardDialog = new WizardDialog(shell, wizard); wizardDialog.open(); doxyfile = wizard.getDoxyfile(); } return doxyfile; } } eclox/eclox.ui/src/eclox/ui/action/BuildPopupActionDelegate.java 0000644 0001750 0000144 00000007006 12166012446 024314 0 ustar willy users /******************************************************************************* * Copyright (C) 2003, 2004? 2007, 2008, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.action; import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.Platform; import org.eclipse.jface.action.IAction; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.ui.IObjectActionDelegate; import org.eclipse.ui.IWorkbenchPart; import eclox.core.doxyfiles.Doxyfile; import eclox.core.doxyfiles.ResourceCollector; import eclox.ui.DoxyfileSelector; import eclox.ui.Plugin; /** * Implement a pop-up menu action delegate that will allow to * launch doxygen builds from resources' contextual menu. * * @author gbrocker */ public class BuildPopupActionDelegate implements IObjectActionDelegate { private IResource resource; ///< References the resource that is under the contextual menu. private IWorkbenchPart targetPart; ///< References the part where the action taks place. /** * @see org.eclipse.ui.IObjectActionDelegate#setActivePart(org.eclipse.jface.action.IAction, org.eclipse.ui.IWorkbenchPart) */ public void setActivePart(IAction action, IWorkbenchPart targetPart) { this.targetPart = targetPart; } /** * @see org.eclipse.ui.IActionDelegate#run(org.eclipse.jface.action.IAction) */ public void run(IAction action) { try { IFile doxyfile = null; // If there is a resource, it is either a doxyfile // and if not, we prompt the user to get one. if( resource != null ) { doxyfile = Doxyfile.isDoxyfile(resource) ? (IFile) resource : DoxyfileSelector.open(resource); } if( doxyfile != null ) { Plugin.getDefault().getBuildManager().build( doxyfile ); } } catch(Throwable throwable) { MessageDialog.openError(targetPart.getSite().getShell(), "Unexpected Error", throwable.toString()); } } /** * @see org.eclipse.ui.IActionDelegate#selectionChanged(org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelection) */ public void selectionChanged(IAction action, ISelection selection) { boolean enabled = false; IStructuredSelection strSelection = (IStructuredSelection) selection; try { if( strSelection.size() == 1 ) { Object object = strSelection.getFirstElement(); IResource resource = (IResource) Platform.getAdapterManager().getAdapter(object, IResource.class); this.resource = resource; if( resource != null && resource.isAccessible() ) { ResourceCollector collector = ResourceCollector.run(resource); // If there is only one collected doxyfile, then assigns that doxyfile as the current resource. this.resource = collector.getSize() == 1 ? collector.getFirst() : this.resource; // Enables the action when a doxyfile has been found. enabled = collector.isEmpty() == false; } } } catch(Throwable throwable) { MessageDialog.openError(targetPart.getSite().getShell(), "Unexpected Error", throwable.toString()); } action.setEnabled(enabled); } } eclox/eclox.ui/src/eclox/ui/PreferencePage.java 0000644 0001750 0000144 00000004565 12166012446 021045 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2004, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui; import org.eclipse.jface.preference.BooleanFieldEditor; import org.eclipse.jface.preference.IntegerFieldEditor; import org.eclipse.jface.preference.RadioGroupFieldEditor; import org.eclipse.swt.widgets.Composite; import org.eclipse.ui.IWorkbench; import org.eclipse.ui.IWorkbenchPreferencePage; /** * Implements the plugin preference page. * * @author gbrocker */ public class PreferencePage extends org.eclipse.jface.preference.FieldEditorPreferencePage implements IWorkbenchPreferencePage { /** * Constructor. */ public PreferencePage() { super( GRID ); } public void init( IWorkbench workbench ) { setPreferenceStore( Plugin.getDefault().getPreferenceStore() ); } /** * Creates the preference page fields. */ protected void createFieldEditors() { Composite rootControl = getFieldEditorParent(); // Create the controls. BooleanFieldEditor escapeValueStrings = new BooleanFieldEditor(IPreferences.HANDLE_ESCAPED_VALUES, "Handle escapes for \" and \\ in value strings", rootControl); escapeValueStrings.setPreferenceStore( getPreferenceStore() ); addField( escapeValueStrings ); IntegerFieldEditor historySize = new IntegerFieldEditor(IPreferences.BUILD_HISTORY_SIZE, "Build history size:", rootControl); historySize.setPreferenceStore( getPreferenceStore() ); historySize.setValidRange( 1, 100 ); addField( historySize ); RadioGroupFieldEditor autoSave = new RadioGroupFieldEditor( IPreferences.AUTO_SAVE, "Save all modified files before building", 1, new String[][] { {IPreferences.AUTO_SAVE_NEVER, IPreferences.AUTO_SAVE_NEVER}, {IPreferences.AUTO_SAVE_ALWAYS, IPreferences.AUTO_SAVE_ALWAYS}, {IPreferences.AUTO_SAVE_ASK, IPreferences.AUTO_SAVE_ASK}, }, rootControl, true ); autoSave.setPreferenceStore( getPreferenceStore() ); addField( autoSave ); } } eclox/eclox.ui/src/eclox/ui/wizard/ 0000755 0001750 0000144 00000000000 12315037715 016617 5 ustar willy users eclox/eclox.ui/src/eclox/ui/wizard/NewDoxyfileWizard.java 0000644 0001750 0000144 00000007326 12166012446 023106 0 ustar willy users /******************************************************************************* * Copyright (C) 2003, 2004, 2007, 2008, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.wizard; import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.ResourcesPlugin; import org.eclipse.core.runtime.IPath; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.wizard.Wizard; import org.eclipse.ui.INewWizard; import org.eclipse.ui.IWorkbench; import eclox.core.doxygen.Doxygen; import eclox.core.doxygen.InvokeException; import eclox.core.doxygen.RunException; import eclox.ui.Plugin; /** * Implement the new file wizard extension to provide a way to create * new doxyfiles. * * @author gbrocker */ public class NewDoxyfileWizard extends Wizard implements INewWizard { private IFile m_doxyfile; ///< The created doxyfile. private NewDoxyfileWizardPage m_page; ///< The wizard page used to get the file name. /** * Retrieves the created doxyfile. * * @return the created doxyfile, null if none */ public IFile getDoxyfile() { return m_doxyfile; } /** * @see org.eclipse.ui.IWorkbenchWizard#init(org.eclipse.ui.IWorkbench, org.eclipse.jface.viewers.IStructuredSelection) */ public void init( IWorkbench workbench, IStructuredSelection selection ) { m_page = new NewDoxyfileWizardPage( selection ); addPage( m_page ); setWindowTitle( "New Doxygen Configuration" ); } /** * @see org.eclipse.jface.wizard.Wizard#performFinish() */ public boolean performFinish() { for(;;) { // Creates the doxyfile resource. IFile doxyfile = createFile( m_page.getContainerFullPath(), m_page.getFileName() ); // Warn user if the doxyfile exists. if( doxyfile.exists() ) { MessageDialog.openWarning(getShell(), "Resource Exists", "The resource " + doxyfile.getFullPath().toString() + " already exists !" ); return false; } // Creates the effective resource file. try { Doxygen.getDefault().generate( doxyfile ); m_doxyfile = doxyfile; return true; } // Doxygen returned an error. catch( RunException runException ) { MessageDialog.openError(getShell(), "Doxygen Error", "An error occured while running doxygen. " + runException.toString()); return true; } // Doxygen was impossible to run. catch( InvokeException invokeException ) { if( Plugin.editPreferencesAfterDoxygenInvocationFailed() ) { continue; } // Stops the wizard. return true; } } } /** * Create the resource file. * * @param containerPath The path to the container for the resource to create. * @param fileName A string containnig the name of the file resource to create. * * @return The created file resource. The file system's file hasn't been created at this step. */ private IFile createFile( IPath containerPath, String fileName ) { IFile result; IPath filePath; String fileExtension; filePath = containerPath.append( fileName ); fileExtension = filePath.getFileExtension(); if( (fileExtension == null || fileExtension.compareToIgnoreCase( "Doxyfile" ) != 0) && fileName.compareToIgnoreCase("Doxyfile") != 0 ) { filePath = filePath.addFileExtension( "Doxyfile" ); } result = ResourcesPlugin.getWorkspace().getRoot().getFile( filePath ); return result; } } eclox/eclox.ui/src/eclox/ui/wizard/NewDoxyfileWizardPage.java 0000644 0001750 0000144 00000004636 12166012446 023704 0 ustar willy users /******************************************************************************* * Copyright (C) 2003-2008, 2013, Guillaume Brocker * * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Guillaume Brocker - Initial API and implementation * ******************************************************************************/ package eclox.ui.wizard; import org.eclipse.core.resources.IResource; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.ui.dialogs.WizardNewFileCreationPage; import eclox.ui.Images; import eclox.ui.Plugin; /** * @author gbrocker * * To change the template for this generated type comment go to * Window - Preferences - Java - Code Generation - Code and Comments */ public class NewDoxyfileWizardPage extends WizardNewFileCreationPage { /** * Retrieves the initial doxyfile name relative to the given object that * is supposed to be a resource. * * If the object is not an IResourec instance, and adapter is searched for it. */ private static String getInitialFileName( Object object ) { IResource resource; // Skip null objects if( object == null ) { resource = null; } // Try the direct convertion to a IResource else if( object instanceof IResource ) { resource = (IResource) object; } // Try to find an adapter else { resource = (IResource) org.eclipse.core.runtime.Platform.getAdapterManager().getAdapter(object, IResource.class); } // Finally, gets the project name for the resource (if one has been found). return (resource != null) ? (resource.getProject().getName() + ".doxyfile") : new String(); } /** * Constructor. * * @param selection The current selection object. */ public NewDoxyfileWizardPage(IStructuredSelection selection) { super("page", selection); setTitle("Doxygen Configuration"); setDescription("Creates a new Doxygen configuration file."); setFileName( selection != null ? getInitialFileName(selection.getFirstElement()) : new String() ); setImageDescriptor( Plugin.getImageDescriptor(Images.DOXYFILE_WIZARD)); } /** * @see org.eclipse.ui.dialogs.WizardNewFileCreationPage#getNewFileLabel() */ protected String getNewFileLabel() { return "Doxyfile &name:"; } } eclox/eclox.ui/.classpath 0000644 0001750 0000144 00000000454 10405226354 014764 0 ustar willy usersEclox, a Doxygen frontend plugin for Eclipse.
Eclox, a Doxygen frontend plugin for Eclipse (home page).
Copyright (C) 2003-2013 Guillaume Brocker
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html.
eclox/eclox.help/html/getting_started.html 0000644 0001750 0000144 00000005001 10335145406 020326 0 ustar willy usersOnce the plugin installed, you must ensure that the default PATH environment variable makes the doxygen binary reachable for the plugin. If not, you can update PATH to include to directory containing the Doxygen binary, or you can tell Eclox where that binary is located on your system (which is in my opinion the better solution). To do this, open Eclipse's preference edition dialog window and go into the new "Doxygen" section.
You can create new Doxygen projects (also called doxyfiles) using the creation wizard. Go to "File->New->Other->Other->Doxygen Configuration". Press next and set both file location and name. Then a empty doxyfile will be created at the specified location, the wizard automatically adds the ".Doxyfile" extension.
You should now see a file with a yellow question mark icon. This is your new doxyfile. Double-clicking on it will open the editor. You can now browse and edit the settings.
Once your have properly set all doxyfile fields, you can launch a documentation build using the toolbar icon showing a yellow question mark. In the case the button is not visible in the toolbar, your current perspective needs to get configured. Go to "Window->Customize perspective->Commands" and in "Available command groups" check "Doxygen". Additionnaly, you can browse the latest builds by clicking the down arrow right to the toolbar button.
When the documentation build starts, a new view showing the build log opens. In its toolbar, a button named "Stop" allows you to halt the current build process. The current build also appears in the Eclipse job progress view and you can control the job from there.
The build toolbar action determine the next doxyfile to build depending on the current active workbench part (editor or view) and the current selection in that part. For example, if the active part is a doxyfile editor, the next doxyfile to build will be the one being edited. If the active part is the resource explorer and the current selection is a doxyfile, that doxyfile will be next to get build. In the case the active part selection doesn't correspond to a doxyfile, the last built doxyfile will be rebuiled. And if the build history is empty, you will be asked for the doxyfile to build.
eclox/eclox.help/COPYING 0000644 0001750 0000144 00000000213 10347236674 014353 0 ustar willy users Please go to either location: * [your eclipse base directory]/plugins/org.gna.eclox_x.y.z/COPYING *This tag specifies the encoding used for all characters in the config file that follow.
The default is UTF-8 which is also the encoding used for all text before the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of possible encodings.
PROJECT_NAME.text = Project Name PROJECT_NAME.group = Project PROJECT_NAME.type = text PROJECT_NAME.note = The PROJECT_NAME tag is a single word (or a sequence of words surrounded by quotes) that should identify the project. PROJECT_NUMBER.text = Project Number PROJECT_NUMBER.group = Project PROJECT_NUMBER.type = text PROJECT_NUMBER.note = The PROJECT_NUMBER tag can be used to enter a project or revision number. This could be handy for archiving the generated documentation or if some version control system is used. OUTPUT_DIRECTORY.text = Output Directory OUTPUT_DIRECTORY.group = Project OUTPUT_DIRECTORY.type = directory OUTPUT_DIRECTORY.note =The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) base path where the generated documentation will be put.
If a relative path is entered, it will be relative to the location where doxygen was started. If left blank the current directory will be used.
CREATE_SUBDIRS.text = Create Subdirectories CREATE_SUBDIRS.group = Project CREATE_SUBDIRS.type = boolean CREATE_SUBDIRS.note =If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-directories (in 2 levels) under the output directory of each output format and will distribute the generated files over these directories.
Enabling this option can be useful when feeding doxygen a huge amount of source files, where putting all generated files in the same directory would otherwise cause performance problems for the file system.
OUTPUT_LANGUAGE.text = Output Language OUTPUT_LANGUAGE.group = Project OUTPUT_LANGUAGE.type = text OUTPUT_LANGUAGE.note =The OUTPUT_LANGUAGE tag is used to specify the language in which all documentation generated by doxygen is written.
Doxygen will use this information to generate all constant output in the proper language. The default language is English, other supported languages are: Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
USE_WINDOWS_ENCODING.text = Use Windows Encoding USE_WINDOWS_ENCODING.group = Project USE_WINDOWS_ENCODING.type = boolean USE_WINDOWS_ENCODING.note =This tag can be used to specify the encoding used in the generated output.
The encoding is not always determined by the language that is chosen, but also whether or not the output is meant for Windows or non-Windows users. In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES forces the Windows encoding (this is the default for the Windows binary), whereas setting the tag to NO uses a Unix-style encoding (the default for all platforms other than Windows).
BRIEF_MEMBER_DESC.text = Brief Member Description BRIEF_MEMBER_DESC.group = Project BRIEF_MEMBER_DESC.type = boolean BRIEF_MEMBER_DESC.note = If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to JavaDoc). Set to NO to disable this. REPEAT_BRIEF.text = Repeat Brief Description REPEAT_BRIEF.group = Project REPEAT_BRIEF.type = boolean REPEAT_BRIEF.note =If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend the brief description of a member or function before the detailed description.
Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be completely suppressed.
ABBREVIATE_BRIEF.text = Abbreviate Brief Description ABBREVIATE_BRIEF.group = Project ABBREVIATE_BRIEF.note =This tag implements a quasi-intelligent brief description abbreviator that is used to form the text in various listings.
Each string in this list, if found as the leading text of the brief description, will be stripped from the text and the result after processing the whole list, is used as the annotated text. Otherwise, the brief description is used as-is.
If left blank, the following values are used ("$name" is automatically replaced with the name of the entity): "The $name class" "The $name widget" "The $name file" "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
ALWAYS_DETAILED_SEC.text = Always Detailed Section ALWAYS_DETAILED_SEC.group = Project ALWAYS_DETAILED_SEC.type = boolean ALWAYS_DETAILED_SEC.note = If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then Doxygen will generate a detailed section even if there is only a brief description. INLINE_INHERITED_MEMB.text = Inline Inherited Members INLINE_INHERITED_MEMB.group = Project INLINE_INHERITED_MEMB.type = boolean INLINE_INHERITED_MEMB.note =If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited members of a class in the documentation of that class as if those members were ordinary class members.
Constructors, destructors and assignment operators of the base classes will not be shown.
FULL_PATH_NAMES.text = Full Path Names FULL_PATH_NAMES.group = Project FULL_PATH_NAMES.type = boolean FULL_PATH_NAMES.note = If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full path before files name in the file list and in the header files. If set to NO the shortest path that makes the file name unique will be used. STRIP_FROM_PATH.text = Strip From Path STRIP_FROM_PATH.group = Project STRIP_FROM_PATH.note =If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
Stripping is only done if one of the specified strings matches the left-hand part of the path. The tag can be used to show relative paths in the file list. If left blank the directory from which doxygen is run is used as the path to strip.
STRIP_FROM_INC_PATH.text = Strip From Include Path STRIP_FROM_INC_PATH.group = Project STRIP_FROM_INC_PATH.note =The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the path mentioned in the documentation of a class, which tells the reader which header file to include in order to use a class.
If left blank only the name of the header file containing the class definition is used. Otherwise one should specify the include paths that are normally passed to the compiler using the -I flag.
SHORT_NAMES.text = Short Names SHORT_NAMES.group = Project SHORT_NAMES.type = boolean SHORT_NAMES.note = If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but less readable) file names. This can be useful is your file systems doesn't support long names like on DOS, Mac, or CD-ROM. JAVADOC_AUTOBRIEF.text = JavaDoc Autobrief JAVADOC_AUTOBRIEF.group = Project JAVADOC_AUTOBRIEF.type = boolean JAVADOC_AUTOBRIEF.note = If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO, the JavaDoc comments will behave just like the Qt-style comments (thus requiring an explicit @brief command for a brief description. QT_AUTOBRIEF.text = QT Autobrief QT_AUTOBRIEF.group = Project QT_AUTOBRIEF.type = boolean QT_AUTOBRIEF.note = If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first line (until the first dot) of a Qt-style comment as the brief description. If set to NO, the comments will behave just like regular Qt-style comments (thus requiring an explicit @brief command for a brief description.) MULTILINE_CPP_IS_BRIEF.text = Multiline C++ is Brief MULTILINE_CPP_IS_BRIEF.group = Project MULTILINE_CPP_IS_BRIEF.type = boolean MULTILINE_CPP_IS_BRIEF.note =The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a multi-line C++ special comment block (i.e. a block of //! or /// comments) as a brief description. This used to be the default behaviour.
The new default is to treat a multi-line C++ comment block as a detailed description. Set this tag to YES if you prefer the old behaviour instead.
DETAILS_AT_TOP.text = Details at Top DETAILS_AT_TOP.group = Project DETAILS_AT_TOP.type = boolean DETAILS_AT_TOP.note = If the DETAILS_AT_TOP tag is set to YES then Doxygen will output the detailed description near the top, like JavaDoc.If set to NO, the detailed description appears after the member documentation. INHERIT_DOCS.text = Inherit Documentations INHERIT_DOCS.group = Project INHERIT_DOCS.type = boolean INHERIT_DOCS.note = If the INHERIT_DOCS tag is set to YES (the default) then an undocumented member inherits the documentation from any documented member that it re-implements. DISTRIBUTE_GROUP_DOC.text = Distribute Group Documentation DISTRIBUTE_GROUP_DOC.group = Project DISTRIBUTE_GROUP_DOC.type = boolean DISTRIBUTE_GROUP_DOC.note = If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC tag is set to YES, then doxygen will reuse the documentation of the first member in the group (if any) for the other members of the group. By default all members of a group must be documented explicitly. SEPARATE_MEMBER_PAGES.text = Separate Member Pages SEPARATE_MEMBER_PAGES.group = Project SEPARATE_MEMBER_PAGES.type = boolean SEPARATE_MEMBER_PAGES.note = If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a new page for each member. If set to NO, the documentation of a member will be part of the file/class/namespace that contains it. TAB_SIZE.text = Tabulation Size TAB_SIZE.group = Project TAB_SIZE.note = The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen uses this value to replace tabs by spaces in code fragments. ALIASES.text = Aliases ALIASES.group = Project ALIASES.type = text list ALIASES.note =This tag can be used to specify a number of aliases that acts as commands in the documentation. An alias has the form "name=value".
For example adding "sideeffect=\par Side Effects:\n" will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will result in a user-defined paragraph with heading "Side Effects:". You can put \n's in the value part of an alias to insert newlines.
OPTIMIZE_OUTPUT_FOR_C.text = Optimize Ouput for C OPTIMIZE_OUTPUT_FOR_C.group = Project OPTIMIZE_OUTPUT_FOR_C.type = boolean OPTIMIZE_OUTPUT_FOR_C.note =Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources only. Doxygen will then generate output that is more tailored for C.
For instance, some of the names that are used will be different. The list of all members will be omitted, etc.
OPTIMIZE_OUTPUT_JAVA.text = Optimize Output Java OPTIMIZE_OUTPUT_JAVA.group = Project OPTIMIZE_OUTPUT_JAVA.type = boolean OPTIMIZE_OUTPUT_JAVA.note =Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources only. Doxygen will then generate output that is more tailored for Java.
For instance, namespaces will be presented as packages, qualified scopes will look different, etc.
BUILTIN_STL_SUPPORT.text = Built-in STL Support BUILTIN_STL_SUPPORT.group = Project BUILTIN_STL_SUPPORT.type = boolean BUILTIN_STL_SUPPORT.note =If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to include (a tag file for) the STL sources as input, then you should set this tag to YES in order to let doxygen match functions declarations and definitions whose arguments contain STL classes (e.g. func(std::string); v.s. func(std::string) {}).
This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate.
CPP_CLI_SUPPORT.text = C++/CLI Support CPP_CLI_SUPPORT.group = Project CPP_CLI_SUPPORT.type = boolean CPP_CLI_SUPPORT.note = If you use Microsoft's C++/CLI language, you should set this option to YES to enable parsing support. DISTRIBUTE_GROUP_DOC.text = Distribute Group Documentation DISTRIBUTE_GROUP_DOC.group = Project DISTRIBUTE_GROUP_DOC.type = boolean DISTRIBUTE_GROUP_DOC.note =If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC tag is set to YES, then doxygen will reuse the documentation of the first member in the group (if any) for the other members of the group.
By default all members of a group must be documented explicitly.
SUBGROUPING.text = Subgrouping SUBGROUPING.group = Project SUBGROUPING.type = boolean SUBGROUPING.note =Set the SUBGROUPING tag to YES (the default) to allow class member groups of the same type (for instance a group of public functions) to be put as a subgroup of that type (e.g. under the Public Functions section). Set it to NO to prevent subgrouping.
Alternatively, this can be done per class using the @nosubgrouping command.
#--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL.text = Extract All EXTRACT_ALL.group = Build EXTRACT_ALL.type = boolean EXTRACT_ALL.note =If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in documentation are documented, even if no documentation was available.
Private class members and static file members will be hidden unless the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES.
EXTRACT_PRIVATE.text = Extract Private EXTRACT_PRIVATE.group = Build EXTRACT_PRIVATE.type = boolean EXTRACT_PRIVATE.note = If the EXTRACT_PRIVATE tag is set to YES all private members of a class will be included in the documentation. EXTRACT_STATIC.text = Extract Static EXTRACT_STATIC.group = Build EXTRACT_STATIC.type = boolean EXTRACT_STATIC.note = If the EXTRACT_STATIC tag is set to YES all static members of a file will be included in the documentation. EXTRACT_LOCAL_CLASSES.text = Extract Local Classes EXTRACT_LOCAL_CLASSES.group = Build EXTRACT_LOCAL_CLASSES.type = boolean EXTRACT_LOCAL_CLASSES.note = If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined locally in source files will be included in the documentation. If set to NO only classes defined in header files are included. EXTRACT_LOCAL_METHODS.text = Extract Local Methods EXTRACT_LOCAL_METHODS.group = Build EXTRACT_LOCAL_METHODS.type = boolean EXTRACT_LOCAL_METHODS.note = This flag is only useful for Objective-C code. When set to YES local methods, which are defined in the implementation section but not in the interface are included in the documentation. If set to NO (the default) only methods in the interface are included. EXTRACT_ANON_NSPACES.text = Extract Anonymous Namespaces EXTRACT_ANON_NSPACES.group = Build EXTRACT_ANON_NSPACES.type = boolean EXTRACT_ANON_NSPACES.note =If this flag is set to YES, the members of anonymous namespaces will be extracted and appear in the documentation as a namespace called 'anonymous_namespace{file}', where file will be replaced with the base name of the file that contains the anonymous namespace.
By default anonymous namespace are hidden.
HIDE_UNDOC_MEMBERS.text = Hide Undocumented Members HIDE_UNDOC_MEMBERS.group = Build HIDE_UNDOC_MEMBERS.type = boolean HIDE_UNDOC_MEMBERS.note =If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all undocumented members of documented classes, files or namespaces. If set to NO (the default) these members will be included in the various overviews, but no documentation section is generated.
This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES.text = Hide Undocumented Classes HIDE_UNDOC_CLASSES.group = Build HIDE_UNDOC_CLASSES.type = boolean HIDE_UNDOC_CLASSES.note =If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all undocumented classes that are normally visible in the class hierarchy. If set to NO (the default) these classes will be included in the various overviews.
This option has no effect if EXTRACT_ALL is enabled.
HIDE_FRIEND_COMPOUNDS.text = Hide Friend Compounds HIDE_FRIEND_COMPOUNDS.group = Build HIDE_FRIEND_COMPOUNDS.type = boolean HIDE_FRIEND_COMPOUNDS.note = If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend (class|struct|union) declarations. If set to NO (the default) these declarations will be included in the documentation. HIDE_IN_BODY_DOCS.text = Hide in Body Documentations HIDE_IN_BODY_DOCS.group = Build HIDE_IN_BODY_DOCS.type = boolean HIDE_IN_BODY_DOCS.note = If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any documentation blocks found inside the body of a function. If set to NO (the default) these blocks will be appended to the function's detailed documentation block. INTERNAL_DOCS.text = Internal Documentations INTERNAL_DOCS.group = Build INTERNAL_DOCS.type = boolean INTERNAL_DOCS.note = The INTERNAL_DOCS tag determines if documentation that is typed after a \internal command is included. If the tag is set to NO (the default) then the documentation will be excluded. Set it to YES to include the internal documentation. CASE_SENSE_NAMES.text = Case Sense Names CASE_SENSE_NAMES.group = Build CASE_SENSE_NAMES.type = boolean CASE_SENSE_NAMES.note =If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate file names in lower-case letters. If set to YES upper-case letters are also allowed.
This is useful if you have classes or files whose names only differ in case and if your file system supports case sensitive file names. Windows and Mac users are advised to set this option to NO.
HIDE_SCOPE_NAMES.text = Hide Scope Names HIDE_SCOPE_NAMES.group = Build HIDE_SCOPE_NAMES.type = boolean HIDE_SCOPE_NAMES.note = If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen will show members with their full class and namespace scopes in the documentation. If set to YES the scope will be hidden. SHOW_INCLUDE_FILES.text = Show Include Files SHOW_INCLUDE_FILES.group = Build SHOW_INCLUDE_FILES.type = boolean SHOW_INCLUDE_FILES.note = If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen will put a list of the files that are included by a file in the documentation of that file. INLINE_INFO.text = Inline Info INLINE_INFO.group = Build INLINE_INFO.type = boolean INLINE_INFO.note = If the INLINE_INFO tag is set to YES (the default) then a tag [inline] is inserted in the documentation for inline members. SORT_MEMBER_DOCS.text = Sort Member Documentations SORT_MEMBER_DOCS.group = Build SORT_MEMBER_DOCS.type = boolean SORT_MEMBER_DOCS.note = If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen will sort the (detailed) documentation of file and class members alphabetically by member name. If set to NO the members will appear in declaration order. SORT_BRIEF_DOCS.text = Sort Brief Documentations SORT_BRIEF_DOCS.group = Build SORT_BRIEF_DOCS.type = boolean SORT_BRIEF_DOCS.note = If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief documentation of file, namespace and class members alphabetically by member name. If set to NO (the default) the members will appear in declaration order. SORT_BY_SCOPE_NAME.text = Sort by Scope Name SORT_BY_SCOPE_NAME.group = Build SORT_BY_SCOPE_NAME.type = boolean SORT_BY_SCOPE_NAME.note =If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by fully-qualified names, including namespaces. If set to NO (the default), the class list will be sorted only by class name, not including the namespace part.
Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Note: This option applies only to the class list, not to the alphabetical list.
GENERATE_TODOLIST.text = Generate Todo List GENERATE_TODOLIST.group = Build GENERATE_TODOLIST.type = boolean GENERATE_TODOLIST.note = The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo list. This list is created by putting \todo commands in the documentation. GENERATE_TESTLIST.text = Generate Test List GENERATE_TESTLIST.group = Build GENERATE_TESTLIST.type = boolean GENERATE_TESTLIST.note = The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test list. This list is created by putting \test commands in the documentation. GENERATE_BUGLIST.text = Generate Bug List GENERATE_BUGLIST.group = Build GENERATE_BUGLIST.type = boolean GENERATE_BUGLIST.note = The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug list. This list is created by putting \bug commands in the documentation. GENERATE_DEPRECATEDLIST.text = Generate Deprecated List GENERATE_DEPRECATEDLIST.group = Build GENERATE_DEPRECATEDLIST.type = boolean GENERATE_DEPRECATEDLIST.note = The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation. ENABLED_SECTIONS.text = Enabled Sections ENABLED_SECTIONS.group = Build ENABLED_SECTIONS.type = text list ENABLED_SECTIONS.note = The ENABLED_SECTIONS tag can be used to enable conditional documentation sections, marked by @if sectionname ... @endif. MAX_INITIALIZER_LINES.text = Maximum Initializer Lines MAX_INITIALIZER_LINES.group = Build MAX_INITIALIZER_LINES.note =The MAX_INITIALIZER_LINES tag determines the maximum number of lines the initial value of a variable or define consists of for it to appear in the documentation. If the initializer consists of more lines than specified here it will be hidden. Use a value of 0 to hide initializers completely.
The appearance of the initializer of individual variables and defines in the documentation can be controlled using @showinitializer or @hideinitializer command in the documentation regardless of this setting.
SHOW_USED_FILES.text = Show Used Files SHOW_USED_FILES.group = Build SHOW_USED_FILES.type = boolean SHOW_USED_FILES.note = Set the SHOW_USED_FILES tag to NO to disable the list of files generated at the bottom of the documentation of classes and structs. If set to YES the list will mention the files that were used to generate the documentation. SHOW_DIRECTORIES.text = Show Directories SHOW_DIRECTORIES.group = Build SHOW_DIRECTORIES.type = boolean SHOW_DIRECTORIES.note = If the sources in your project are distributed over multiple directories then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy in the documentation. FILE_VERSION_FILTER.text = File Version Filter FILE_VERSION_FILTER.group = Build FILE_VERSION_FILTER.type = file FILE_VERSION_FILTER.note =The FILE_VERSION_FILTER tag can be used to specify a program or script that doxygen should invoke to get the current version for each file (typically from the version control system).
Doxygen will invoke the program by executing (via popen()) the command <command> <input-file>, where <command> is the value of the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file provided by doxygen. Whatever the program writes to standard output is used as the file version. See the manual for examples.
#--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET.text = Quiet QUIET.group = Messages QUIET.type = boolean QUIET.note = The QUIET tag can be used to turn on/off the messages that are generated by doxygen. Possible values are YES and NO. If left blank NO is used. WARNINGS.text = Warnings WARNINGS.group = Messages WARNINGS.type = boolean WARNINGS.note = The WARNINGS tag can be used to turn on/off the warning messages that are generated by doxygen. Possible values are YES and NO. If left blank NO is used. WARN_IF_UNDOCUMENTED.text = Warn if Undocumented WARN_IF_UNDOCUMENTED.group = Messages WARN_IF_UNDOCUMENTED.type = boolean WARN_IF_UNDOCUMENTED.note = If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag will automatically be disabled. WARN_IF_DOC_ERROR.text = Warn if Documentation Error WARN_IF_DOC_ERROR.group = Messages WARN_IF_DOC_ERROR.type = boolean WARN_IF_DOC_ERROR.note = If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for potential errors in the documentation, such as not documenting some parameters in a documented function, or documenting parameters that don't exist or using markup commands wrongly. WARN_NO_PARAMDOC.text = Warn for undocumented function parameters WARN_NO_PARAMDOC.group = Messages WARN_NO_PARAMDOC.type = boolean WARN_NO_PARAMDOC.note = This WARN_NO_PARAMDOC option can be abled to get warnings for functions that are documented, but have no documentation for their parameters or return value. If set to NO (the default) doxygen will only warn about wrong or incomplete parameter documentation, but not about the absence of documentation. WARN_FORMAT.text = Warn Format WARN_FORMAT.group = Messages WARN_FORMAT.type = text WARN_FORMAT.note = The WARN_FORMAT tag determines the format of the warning messages that doxygen can produce. The string should contain the $file, $line, and $text tags, which will be replaced by the file and line number from which the warning originated and the warning text. WARN_LOGFILE.text = Warn Logfile WARN_LOGFILE.group = Messages WARN_LOGFILE.type = file WARN_LOGFILE.note = The WARN_LOGFILE tag can be used to specify a file to which warning and error messages should be written. If left blank the output is written to stderr. #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- INPUT.text = Input INPUT.group = Inputs INPUT.type = path list INPUT.note = The INPUT tag can be used to specify the files and/or directories that contain documented source files. You may enter file names like "myfile.cpp" or directories like "/usr/src/myproject". Separate the files or directories with spaces. INPUT_ENCODING.text = Input Encoding INPUT_ENCODING.group = Inputs INPUT_ENCODING.type = text INPUT_ENCODING.note =This tag can be used to specify the character encoding of the source files that doxygen parses.
Internally doxygen uses the UTF-8 encoding, which is also the default input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of possible encodings.
FILE_PATTERNS.text = File Patterns FILE_PATTERNS.group = Inputs FILE_PATTERNS.type = text list FILE_PATTERNS.note =If the value of the INPUT tag contains directories, you can use the FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and *.h) to filter out the source-files in the directories.
If left blank the following patterns are tested: *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
RECURSIVE.text = Recursive RECURSIVE.group = Inputs RECURSIVE.type = boolean RECURSIVE.note = The RECURSIVE tag can be used to turn specify whether or not subdirectories should be searched for input files as well. Possible values are YES and NO. If left blank NO is used. EXCLUDE.text = Exclude EXCLUDE.group = Inputs EXCLUDE.type = path list EXCLUDE.note = The EXCLUDE tag can be used to specify files and/or directories that should excluded from the INPUT source files. This way you can easily exclude a subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE_SYMLINKS.text = Exclude Symlinks EXCLUDE_SYMLINKS.group = Inputs EXCLUDE_SYMLINKS.type = boolean EXCLUDE_SYMLINKS.note = The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories that are symbolic links (a Unix filesystem feature) are excluded from the input. EXCLUDE_SYMBOLS.text = Exclude Symbols EXCLUDE_SYMBOLS.group = Inputs EXCLUDE_SYMBOLS.type = text list EXCLUDE_SYMBOLS.note =The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names (namespaces, classes, functions, etc.) that should be excluded from the output.
The symbol name can be a fully qualified name, a word, or if the wildcard * is used, a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
EXCLUDE_PATTERNS.text = Exclude Patterns EXCLUDE_PATTERNS.group = Inputs EXCLUDE_PATTERNS.type = text list EXCLUDE_PATTERNS.note = If the value of the INPUT tag contains directories, you can use the EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude certain files from those directories. EXAMPLE_PATH.text = Example Path EXAMPLE_PATH.group = Inputs EXAMPLE_PATH.type = path list EXAMPLE_PATH.note = The EXAMPLE_PATH tag can be used to specify one or more files or directories that contain example code fragments that are included (see the \include command). EXAMPLE_PATTERNS.text = Example Patterns EXAMPLE_PATTERNS.group = Inputs EXAMPLE_PATTERNS.type = text list EXAMPLE_PATTERNS.note = If the value of the EXAMPLE_PATH tag contains directories, you can use the EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and *.h) to filter out the source-files in the directories. If left blank all files are included. EXAMPLE_RECURSIVE.text = Example Recursive EXAMPLE_RECURSIVE.group = Inputs EXAMPLE_RECURSIVE.type = boolean EXAMPLE_RECURSIVE.note = If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be searched for input files to be used with the \include or \dontinclude commands irrespective of the value of the RECURSIVE tag. Possible values are YES and NO. If left blank NO is used. IMAGE_PATH.text = Image Path IMAGE_PATH.group = Inputs IMAGE_PATH.type = path list IMAGE_PATH.note = The IMAGE_PATH tag can be used to specify one or more files or directories that contain image that are included in the documentation (see the \image command). INPUT_FILTER.text = Input Filter INPUT_FILTER.group = Inputs INPUT_FILTER.type = file INPUT_FILTER.note =The INPUT_FILTER tag can be used to specify a program that doxygen should invoke to filter for each input file.
Doxygen will invoke the filter program by executing (via popen()) the command <filter> <input-file>, where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the name of an input file. Doxygen will then use the output that the filter program writes to standard output.
If FILTER_PATTERNS is specified, this tag will be ignored.
FILTER_PATTERNS.text = Filter Patterns FILTER_PATTERNS.group = Inputs FILTER_PATTERNS.type = text list FILTER_PATTERNS.note =The FILTER_PATTERNS tag can be used to specify filters on a per file pattern basis. Doxygen will compare the file name with each pattern and apply the filter if there is a match.
The filters are a list of the form: pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further info on how filters are used.
If FILTER_PATTERNS is empty, INPUT_FILTER is applied to all files.
FILTER_SOURCE_FILES.text = Filter Source Files FILTER_SOURCE_FILES.group = Inputs FILTER_SOURCE_FILES.type = boolean FILTER_SOURCE_FILES.note = If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using INPUT_FILTER) will be used to filter the input files when producing source files to browse (i.e. when SOURCE_BROWSER is set to YES). #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- SOURCE_BROWSER.text = Source Browser SOURCE_BROWSER.group = Source Browsing SOURCE_BROWSER.type = boolean SOURCE_BROWSER.note =If the SOURCE_BROWSER tag is set to YES then a list of source files will be generated. Documented entities will be cross-referenced with these sources.
Note: To get rid of all source code in the generated output, make sure also VERBATIM_HEADERS is set to NO.
INLINE_SOURCES.text = Inline Sources INLINE_SOURCES.group = Source Browsing INLINE_SOURCES.type = boolean INLINE_SOURCES.note = Setting the INLINE_SOURCES tag to YES will include the body of functions and classes directly in the documentation. STRIP_CODE_COMMENTS.text = Strip Code Comments STRIP_CODE_COMMENTS.group = Source Browsing STRIP_CODE_COMMENTS.type = boolean STRIP_CODE_COMMENTS.note = Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct doxygen to hide any special comment blocks from generated source code fragments. Normal C and C++ comments will always remain visible. REFERENCED_BY_RELATION.text = Referenced by Relation REFERENCED_BY_RELATION.group = Source Browsing REFERENCED_BY_RELATION.type = boolean REFERENCED_BY_RELATION.note = If the REFERENCED_BY_RELATION tag is set to YES (the default) then for each documented function all documented functions referencing it will be listed. REFERENCES_RELATION.text = References Relation REFERENCES_RELATION.group = Source Browsing REFERENCES_RELATION.type = boolean REFERENCES_RELATION.note = If the REFERENCES_RELATION tag is set to YES (the default) then for each documented function all documented entities called/used by that function will be listed. REFERENCES_LINK_SOURCE.text = Reference Link Source REFERENCES_LINK_SOURCE.group = Source Browsing REFERENCES_LINK_SOURCE.type = boolean REFERENCES_LINK_SOURCE.note = If the REFERENCES_LINK_SOURCE tag is set to YES (the default) and SOURCE_BROWSER tag is set to YES, then the hyperlinks from functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will link to the documentstion. USE_HTAGS.text = Use htags USE_HTAGS.group = Source Browsing USE_HTAGS.type = boolean USE_HTAGS.note =If the USE_HTAGS tag is set to YES then the references to source code will point to the HTML generated by the htags(1) tool instead of doxygen built-in source browser.
The htags tool is part of GNU's global source tagging system (see http://www.gnu.org/software/global/global.html). You will need version 4.8.6 or higher.
VERBATIM_HEADERS.text = Verbatim Headers VERBATIM_HEADERS.group = Source Browsing VERBATIM_HEADERS.type = boolean VERBATIM_HEADERS.note = If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this. #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX.text = Alphabetical Index ALPHABETICAL_INDEX.group = Alphabetical Class Index ALPHABETICAL_INDEX.type = boolean ALPHABETICAL_INDEX.note = If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all compounds will be generated. Enable this if the project contains a lot of classes, structs, unions or interfaces. COLS_IN_ALPHA_INDEX.text = Columns in Alphabetical Index COLS_IN_ALPHA_INDEX.group = Alphabetical Class Index COLS_IN_ALPHA_INDEX.note = If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in which this list will be split (can be a number in the range [1..20]) IGNORE_PREFIX.text = Ignore Prefix IGNORE_PREFIX.group = Alphabetical Class Index IGNORE_PREFIX.type = text list IGNORE_PREFIX.note = In case all classes in a project start with a common prefix, all classes will be put under the same header in the alphabetical index. The IGNORE_PREFIX tag can be used to specify one or more prefixes that should be ignored while generating the index headers. #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML.text = Generate HTML GENERATE_HTML.group = HTML Output GENERATE_HTML.type = boolean GENERATE_HTML.note = If the GENERATE_HTML tag is set to YES (the default) Doxygen will generate HTML output. HTML_OUTPUT.text = HTML Output HTML_OUTPUT.group = HTML Output HTML_OUTPUT.type = directory HTML_OUTPUT.note = The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank `html' will be used as the default path. HTML_FILE_EXTENSION.text = HTML File Extension HTML_FILE_EXTENSION.group = HTML Output HTML_FILE_EXTENSION.note = The HTML_FILE_EXTENSION tag can be used to specify the file extension for each generated HTML page (for example: .htm,.php,.asp). If it is left blank doxygen will generate files with .html extension. HTML_HEADER.text = HTML Header HTML_HEADER.group = HTML Output HTML_HEADER.type = file HTML_HEADER.note = The HTML_HEADER tag can be used to specify a personal HTML header for each generated HTML page. If it is left blank doxygen will generate a standard header. HTML_FOOTER.text = HTML Footer HTML_FOOTER.group = HTML Output HTML_FOOTER.type = file HTML_FOOTER.note = The HTML_FOOTER tag can be used to specify a personal HTML footer for each generated HTML page. If it is left blank doxygen will generate a standard footer. HTML_STYLESHEET.text = HTML Stylesheet HTML_STYLESHEET.group = HTML Output HTML_STYLESHEET.type = file HTML_STYLESHEET.note =The HTML_STYLESHEET tag can be used to specify a user-defined cascading style sheet that is used by each HTML page. It can be used to fine-tune the look of the HTML output. If the tag is left blank doxygen will generate a default style sheet.
Note that doxygen will try to copy the style sheet file to the HTML output directory, so don't put your own stylesheet in the HTML output directory as well, or it will be erased!
HTML_ALIGN_MEMBERS.text = HTML Align Members HTML_ALIGN_MEMBERS.group = HTML Output HTML_ALIGN_MEMBERS.type = boolean HTML_ALIGN_MEMBERS.note = If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, files or namespaces will be aligned in HTML using tables. If set to NO a bullet list will be used. GENERATE_HTMLHELP.text = Generate HTML Help GENERATE_HTMLHELP.group = HTML Output GENERATE_HTMLHELP.type = boolean GENERATE_HTMLHELP.note = If the GENERATE_HTMLHELP tag is set to YES, additional index files will be generated that can be used as input for tools like the Microsoft HTML help workshop to generate a compressed HTML help file (.chm) of the generated HTML documentation. HTML_DYNAMIC_SECTIONS.text = HTML Dynamic Sections HTML_DYNAMIC_SECTIONS.group = HTML Output HTML_DYNAMIC_SECTIONS.type = boolean HTML_DYNAMIC_SECTIONS.note =If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML documentation will contain sections that can be hidden and shown after the page has loaded.
For this to work a browser that supports JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox, Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
CHM_FILE.text = CHM File CHM_FILE.group = HTML Output CHM_FILE.type = file CHM_FILE.note = If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can be used to specify the file name of the resulting .chm file. You can add a path in front of the file if the result should not be written to the html output directory. HHC_LOCATION.text = HHC Location HHC_LOCATION.group = HTML Output HHC_LOCATION.type = file HHC_LOCATION.note = If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can be used to specify the location (absolute path including file name) of the HTML help compiler (hhc.exe). If non-empty doxygen will try to run the HTML help compiler on the generated index.hhp. GENERATE_CHI.text = Generate CHI GENERATE_CHI.group = HTML Output GENERATE_CHI.type = boolean GENERATE_CHI.note = If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag controls if a separate .chi index file is generated (YES) or that it should be included in the master .chm file (NO). BINARY_TOC.text = Binary TOC BINARY_TOC.group = HTML Output BINARY_TOC.type = boolean BINARY_TOC.note = If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag controls whether a binary table of contents is generated (YES) or a normal table of contents (NO) in the .chm file. TOC_EXPAND.text = TOC Expand TOC_EXPAND.group = HTML Output TOC_EXPAND.type = boolean TOC_EXPAND.note = The TOC_EXPAND flag can be set to YES to add extra items for group members to the contents of the HTML help documentation and to the tree view. DISABLE_INDEX.text = Disable Index DISABLE_INDEX.group = HTML Output DISABLE_INDEX.type = boolean DISABLE_INDEX.note = The DISABLE_INDEX tag can be used to turn on/off the condensed index at top of each HTML page. The value NO (the default) enables the index and the value YES disables it. ENUM_VALUES_PER_LINE.text = Enum Values per Line ENUM_VALUES_PER_LINE.group = HTML Output ENUM_VALUES_PER_LINE.note = This tag can be used to set the number of enum values (range [1..20]) that doxygen will group on one line in the generated HTML documentation. GENERATE_TREEVIEW.text = Generate Tree View GENERATE_TREEVIEW.group = HTML Output GENERATE_TREEVIEW.type = boolean GENERATE_TREEVIEW.note =If the GENERATE_TREEVIEW tag is set to YES, a side panel will begenerated containing a tree-like index structure (just like the one that is generated for HTML Help).
For this to work a browser that supports JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are probably better off using the HTML help feature.
TREEVIEW_WIDTH.text = Tree View Width TREEVIEW_WIDTH.group = HTML Output TREEVIEW_WIDTH.note = If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used to set the initial width (in pixels) of the frame in which the tree is shown. #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- GENERATE_LATEX.text = Generate LaTeX GENERATE_LATEX.group = LaTeX output GENERATE_LATEX.type = boolean GENERATE_LATEX.note = If the GENERATE_LATEX tag is set to YES (the default) Doxygen will generate Latex output. LATEX_OUTPUT.text = LaTeX Output LATEX_OUTPUT.group = LaTeX output LATEX_OUTPUT.type = directory LATEX_OUTPUT.note = The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank `latex' will be used as the default path. LATEX_CMD_NAME.text = LaTeX Command Name LATEX_CMD_NAME.group = LaTeX output LATEX_CMD_NAME.note = The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name. MAKEINDEX_CMD_NAME.text = makeindex Command Name MAKEINDEX_CMD_NAME.group = LaTeX output MAKEINDEX_CMD_NAME.note = The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate index for LaTeX. If left blank `makeindex' will be used as the default command name. COMPACT_LATEX.text = Compact LaTeX COMPACT_LATEX.group = LaTeX output COMPACT_LATEX.type = boolean COMPACT_LATEX.note = If the COMPACT_LATEX tag is set to YES Doxygen generates more compact LaTeX documents. This may be useful for small projects and may help to save some trees in general. PAPER_TYPE.text = Paper Type PAPER_TYPE.group = LaTeX output PAPER_TYPE.note = The PAPER_TYPE tag can be used to set the paper type that is used by the printer. Possible values are: a4, a4wide, letter, legal and executive. If left blank a4wide will be used. EXTRA_PACKAGES.text = Extra Packages EXTRA_PACKAGES.group = LaTeX output EXTRA_PACKAGES.note = The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX packages that should be included in the LaTeX output. LATEX_HEADER.text = LaTeX Header LATEX_HEADER.group = LaTeX output LATEX_HEADER.type = file LATEX_HEADER.note = The LATEX_HEADER tag can be used to specify a personal LaTeX header for the generated latex document. The header should contain everything until the first chapter. If it is left blank doxygen will generate a standard header. Notice: only use this tag if you know what you are doing! PDF_HYPERLINKS.text = PDF Hyperlinks PDF_HYPERLINKS.group = LaTeX output PDF_HYPERLINKS.type = boolean PDF_HYPERLINKS.note = If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is prepared for conversion to pdf (using ps2pdf). The pdf file will contain links (just like the HTML output) instead of page references This makes the output suitable for online browsing using a pdf viewer. USE_PDFLATEX.text = Use pdflatex USE_PDFLATEX.group = LaTeX output USE_PDFLATEX.type = boolean USE_PDFLATEX.note = If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of plain latex in the generated Makefile. Set this option to YES to get a higher quality PDF documentation. LATEX_BATCHMODE.text = LaTeX Batch Mode LATEX_BATCHMODE.group = LaTeX output LATEX_BATCHMODE.type = boolean LATEX_BATCHMODE.note = If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. command to the generated LaTeX files. This will instruct LaTeX to keep running if errors occur, instead of asking the user for help. This option is also used when generating formulas in HTML. LATEX_HIDE_INDICES.text = LaTeX Hide Indices LATEX_HIDE_INDICES.group = LaTeX output LATEX_HIDE_INDICES.type = boolean LATEX_HIDE_INDICES.note = If LATEX_HIDE_INDICES is set to YES then doxygen will not include the index chapters (such as File Index, Compound Index, etc.) in the output. #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- GENERATE_RTF.text = Generate RTF GENERATE_RTF.group = RTF Output GENERATE_RTF.type = boolean GENERATE_RTF.note = If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output The RTF output is optimized for Word 97 and may not look very pretty with other RTF readers or editors. RTF_OUTPUT.text = RTF Output RTF_OUTPUT.group = RTF Output RTF_OUTPUT.type = directory RTF_OUTPUT.note = The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank `rtf' will be used as the default path. COMPACT_RTF.text = Compact RTF COMPACT_RTF.group = RTF Output COMPACT_RTF.type = boolean COMPACT_RTF.note = If the COMPACT_RTF tag is set to YES Doxygen generates more compact RTF documents. This may be useful for small projects and may help to save some trees in general. RTF_HYPERLINKS.text = RTF Hyperlinks RTF_HYPERLINKS.group = RTF Output RTF_HYPERLINKS.type = boolean RTF_HYPERLINKS.note =If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will contain hyperlink fields. The RTF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using WORD or other programs which support those fields.
Note: wordpad (write) and others do not support links.
RTF_STYLESHEET_FILE.text = RTF Stylesheet File RTF_STYLESHEET_FILE.group = RTF Output RTF_STYLESHEET_FILE.note = Load stylesheet definitions from file. Syntax is similar to doxygen's config file, i.e. a series of assignments. You only have to provide replacements, missing definitions are set to their default value. RTF_EXTENSIONS_FILE.text = RTF Extensions File RTF_EXTENSIONS_FILE.group = RTF Output RTF_EXTENSIONS_FILE.note = Set optional variables used in the generation of an rtf document. Syntax is similar to doxygen's config file. #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- GENERATE_MAN.text = Generate man GENERATE_MAN.group = man Output GENERATE_MAN.type = boolean GENERATE_MAN.note = If the GENERATE_MAN tag is set to YES (the default) Doxygen will generate man pages. MAN_OUTPUT.text = man Output MAN_OUTPUT.group = man Output MAN_OUTPUT.type = directory MAN_OUTPUT.note = The MAN_OUTPUT tag is used to specify where the man pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank `man' will be used as the default path. MAN_EXTENSION.text = man Extension MAN_EXTENSION.group = man Output MAN_EXTENSION.note = The MAN_EXTENSION tag determines the extension that is added to the generated man pages (default is the subroutine's section .3) MAN_LINKS.text = man Links MAN_LINKS.group = man Output MAN_LINKS.type = boolean MAN_LINKS.note = If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it will generate one additional man file for each entity documented in the real man page(s). These additional files only source the real man page, but without them the man command would be unable to find the correct page. The default is NO. #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- GENERATE_XML.text = Generate XML GENERATE_XML.group = XML Output GENERATE_XML.type = boolean GENERATE_XML.note = If the GENERATE_XML tag is set to YES Doxygen will generate an XML file that captures the structure of the code including all documentation. XML_OUTPUT.text = XML Output XML_OUTPUT.group = XML Output XML_OUTPUT.type = directory XML_OUTPUT.note = The XML_OUTPUT tag is used to specify where the XML pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank `xml' will be used as the default path. XML_SCHEMA.text = XML Schema XML_SCHEMA.group = XML Output XML_SCHEMA.type = file XML_SCHEMA.note = The XML_SCHEMA tag can be used to specify an XML schema, which can be used by a validating XML parser to check the syntax of the XML files. XML_DTD.text = XML DTD XML_DTD.group = XML Output XML_DTD.type = file XML_DTD.note = The XML_DTD tag can be used to specify an XML DTD, which can be used by a validating XML parser to check the syntax of the XML files. XML_PROGRAMLISTING.text = XML Program Listing XML_PROGRAMLISTING.group = XML Output XML_PROGRAMLISTING.type = boolean XML_PROGRAMLISTING.note = If the XML_PROGRAMLISTING tag is set to YES Doxygen will dump the program listings (including syntax highlighting and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output. #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF.text = Generate Autogen Definition GENERATE_AUTOGEN_DEF.type = boolean GENERATE_AUTOGEN_DEF.note = If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will generate an AutoGen Definitions (see autogen.sf.net) file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment. #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- GENERATE_PERLMOD.text = Generate Perl Module GENERATE_PERLMOD.group = Perl Module Output GENERATE_PERLMOD.type = boolean GENERATE_PERLMOD.note = If the GENERATE_PERLMOD tag is set to YES Doxygen will generate a Perl module file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment. PERLMOD_LATEX.text = Perl Module LaTeX PERLMOD_LATEX.group = Perl Module Output PERLMOD_LATEX.type = boolean PERLMOD_LATEX.note = If the PERLMOD_LATEX tag is set to YES Doxygen will generate the necessary Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI output from the Perl module output. PERLMOD_PRETTY.text = Perl Module Pretty PERLMOD_PRETTY.group = Perl Module Output PERLMOD_PRETTY.type = boolean PERLMOD_PRETTY.note = If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely formatted so it can be parsed by a human reader. This is useful if you want to understand what is going on. On the other hand, if this tag is set to NO the size of the Perl module output will be much smaller and Perl will parse it just the same. PERLMOD_MAKEVAR_PREFIX.text = Perl Module MakeVar Prefix PERLMOD_MAKEVAR_PREFIX.group = Perl Module Output PERLMOD_MAKEVAR_PREFIX.note = The names of the make variables in the generated doxyrules.make file are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful so different doxyrules.make files included by the same Makefile don't overwrite each other's variables. #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING.text = Enable Preprocessing ENABLE_PREPROCESSING.group = Preprocessing ENABLE_PREPROCESSING.type = boolean ENABLE_PREPROCESSING.note = If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will evaluate all C-preprocessor directives found in the sources and include files. MACRO_EXPANSION.text = Macro Expansion MACRO_EXPANSION.group = Preprocessing MACRO_EXPANSION.type = boolean MACRO_EXPANSION.note = If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro names in the source code. If set to NO (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting EXPAND_ONLY_PREDEF to YES. EXPAND_ONLY_PREDEF.text = Expand Only Predefined EXPAND_ONLY_PREDEF.group = Preprocessing EXPAND_ONLY_PREDEF.type = boolean EXPAND_ONLY_PREDEF.note = If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then the macro expansion is limited to the macros specified with the PREDEFINED and EXPAND_AS_DEFINED tags. SEARCH_INCLUDES.text = Search Includes SEARCH_INCLUDES.group = Preprocessing SEARCH_INCLUDES.type = boolean SEARCH_INCLUDES.note = If the SEARCH_INCLUDES tag is set to YES (the default) the includes files in the INCLUDE_PATH (see below) will be search if a #include is found. INCLUDE_PATH.text = Include Path INCLUDE_PATH.group = Preprocessing INCLUDE_PATH.type = directory list INCLUDE_PATH.note = The INCLUDE_PATH tag can be used to specify one or more directories that contain include files that are not input files but should be processed by the preprocessor. INCLUDE_FILE_PATTERNS.text = Include File Patterns INCLUDE_FILE_PATTERNS.group = Preprocessing INCLUDE_FILE_PATTERNS.type = text list INCLUDE_FILE_PATTERNS.note = You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard patterns (like *.h and *.hpp) to filter out the header-files in the directories. If left blank, the patterns specified with FILE_PATTERNS will be used. PREDEFINED.text = Predefined PREDEFINED.group = Preprocessing PREDEFINED.type = text list PREDEFINED.note =The PREDEFINED tag can be used to specify one or more macro names that are defined before the preprocessor is started (similar to the -D option of gcc).
The argument of the tag is a list of macros of the form: name or name=definition (no spaces). If the definition and the = are omitted =1 is assumed. To prevent a macro definition from being undefined via #undef or recursively expanded use the := operator instead of the = operator.
EXPAND_AS_DEFINED.text = Expand as Defined EXPAND_AS_DEFINED.group = Preprocessing EXPAND_AS_DEFINED.type = text list EXPAND_AS_DEFINED.note = If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this tag can be used to specify a list of macro names that should be expanded. The macro definition that is found in the sources will be used. Use the PREDEFINED tag if you want to use a different macro definition. SKIP_FUNCTION_MACROS.text = Skip Function Macros SKIP_FUNCTION_MACROS.group = Preprocessing SKIP_FUNCTION_MACROS.type = boolean SKIP_FUNCTION_MACROS.note = If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then doxygen's preprocessor will remove all function-like macros that are alone on a line, have an all uppercase name, and do not end with a semicolon. Such function macros are typically used for boiler-plate code, and will confuse the parser if not removed. #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- TAGFILES.text = Tag Files TAGFILES.group = External References TAGFILES.type = text list TAGFILES.note =The TAGFILES option can be used to specify one or more tagfiles.
Optionally an initial location of the external documentation can be added for each tagfile. The format of a tag file without this location is as follows:
TAGFILES = file1 file2 ...
Adding location for the tag files is done as follows:
TAGFILES = file1=loc1 "file2 = loc2" ...
where "loc1" and "loc2" can be relative or absolute paths or URLs. If a location is present for each tag, the installdox tool does not have to be run to correct the links.
Note that each tag file must have a unique name (where the name does NOT include the path). If a tag file is not located in the directory in which doxygen is run, you must also specify the path to the tagfile here.
GENERATE_TAGFILE.text = Generate Tag Files GENERATE_TAGFILE.group = External References GENERATE_TAGFILE.type = file GENERATE_TAGFILE.note = When a file name is specified after GENERATE_TAGFILE, doxygen will create a tag file that is based on the input files it reads. ALLEXTERNALS.text = All Externals ALLEXTERNALS.group = External References ALLEXTERNALS.type = boolean ALLEXTERNALS.note = If the ALLEXTERNALS tag is set to YES all external classes will be listed in the class index. If set to NO only the inherited external classes will be listed. EXTERNAL_GROUPS.text = External Groups EXTERNAL_GROUPS.group = External References EXTERNAL_GROUPS.type = boolean EXTERNAL_GROUPS.note = If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in the modules index. If set to NO, only the current project's groups will be listed. PERL_PATH.text = Perl Path PERL_PATH.group = External References PERL_PATH.type = file PERL_PATH.note = The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of `which perl'). #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS.text = Class Diagrams CLASS_DIAGRAMS.group = dot Tool CLASS_DIAGRAMS.type = boolean CLASS_DIAGRAMS.note =If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or super classes. Setting the tag to NO turns the diagrams off.
Note that this option is superseded by the HAVE_DOT option below. This is only a fallback. It is recommended to install and use dot, since it yields more powerful graphs.
MSCGEN_PATH.text = mscgen Path MSCGEN_PATH.group = dot Tool MSCGEN_PATH.type = directory MSCGEN_PATH.note =You can define message sequence charts within doxygen comments using the @msc command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the documentation.
The MSCGEN_PATH tag allows you to specify the directory where the mscgen tool resides. If left empty the tool is assumed to be found in the default search path.
HIDE_UNDOC_RELATIONS.text = Hide Undocumented Relations HIDE_UNDOC_RELATIONS.group = dot Tool HIDE_UNDOC_RELATIONS.type = boolean HIDE_UNDOC_RELATIONS.note = If set to YES, the inheritance and collaboration graphs will hide inheritance and usage relations if the target is undocumented or is not a class. HAVE_DOT.text = Have DOT HAVE_DOT.group = dot Tool HAVE_DOT.type = boolean HAVE_DOT.note = If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is available from the path. This tool is part of Graphviz, a graph visualization toolkit from AT&T and Lucent Bell Labs. The other options in this section have no effect if this option is set to NO (the default) CLASS_GRAPH.text = Class Graph CLASS_GRAPH.group = dot Tool CLASS_GRAPH.type = boolean CLASS_GRAPH.note = If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations. Setting this tag to YES will force the the CLASS_DIAGRAMS tag to NO. COLLABORATION_GRAPH.text = Collaboration Graph COLLABORATION_GRAPH.group = dot Tool COLLABORATION_GRAPH.type = boolean COLLABORATION_GRAPH.note = If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes. GROUP_GRAPHS.text = Groups Graphs GROUP_GRAPHS.group = dot Tool GROUP_GRAPHS.type = boolean GROUP_GRAPHS.note = If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen will generate a graph for groups, showing the direct groups dependencies. UML_LOOK.text = UML Look UML_LOOK.group = dot Tool UML_LOOK.type = boolean UML_LOOK.note = If the UML_LOOK tag is set to YES doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language. TEMPLATE_RELATIONS.text = Template Relations TEMPLATE_RELATIONS.group = dot Tool TEMPLATE_RELATIONS.type = boolean TEMPLATE_RELATIONS.note = If set to YES, the inheritance and collaboration graphs will show the relations between templates and their instances. INCLUDE_GRAPH.text = Include Graph INCLUDE_GRAPH.group = dot Tool INCLUDE_GRAPH.type = boolean INCLUDE_GRAPH.note = If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. INCLUDED_BY_GRAPH.text = Included-by Graph INCLUDED_BY_GRAPH.group = dot Tool INCLUDED_BY_GRAPH.type = boolean INCLUDED_BY_GRAPH.note = If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented header file showing the documented files that directly or indirectly include this file. CALL_GRAPH.text = Call Graph CALL_GRAPH.group = dot Tool CALL_GRAPH.type = boolean CALL_GRAPH.note =If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a call dependency graph for every global function or class method.
Note that enabling this option will significantly increase the time of a run. So in most cases it will be better to enable call graphs for selected functions only using the @callgraph command.
CALLER_GRAPH.text = Caller Graph CALLER_GRAPH.group = dot Tool CALLER_GRAPH.type = boolean CALLER_GRAPH.note =If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a caller dependency graph for every global function or class method.
Note that enabling this option will significantly increase the time of a run. So in most cases it will be better to enable caller graphs for selected functions only using the @callergraph command.
GRAPHICAL_HIERARCHY.text = Graphical Hierarchy GRAPHICAL_HIERARCHY.group = dot Tool GRAPHICAL_HIERARCHY.type = boolean GRAPHICAL_HIERARCHY.note = If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen will graphical hierarchy of all classes instead of a textual one. DIRECTORY_GRAPH.text = Directory Graph DIRECTORY_GRAPH.group = dot Tool DIRECTORY_GRAPH.type = boolean DIRECTORY_GRAPH.note = If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES then doxygen will show the dependencies a directory has on other directories in a graphical way. The dependency relations are determined by the #include relations between the files in the directories. DOT_IMAGE_FORMAT.text = DOT Image Format DOT_IMAGE_FORMAT.group = dot Tool DOT_IMAGE_FORMAT.type = text DOT_IMAGE_FORMAT.note = The DOT_IMAGE_FORMAT tag can be used to set the image format of the images generated by dot. Possible values are png, jpg, or gif. If left blank png will be used. DOT_PATH.text = DOT Path DOT_PATH.group = dot Tool DOT_PATH.type = file DOT_PATH.note = The tag DOT_PATH can be used to specify the path where the dot tool can be found. If left blank, it is assumed the dot tool can be found on the path. DOTFILE_DIRS.text = DOT Files Directories DOTFILE_DIRS.group = dot Tool DOTFILE_DIRS.type = directory list DOTFILE_DIRS.note = The DOTFILE_DIRS tag can be used to specify one or more directories that contain dot files that are included in the documentation (see the \dotfile command). MAX_DOT_GRAPH_WIDTH.text = Maximum DOT Graph Width MAX_DOT_GRAPH_WIDTH.group = dot Tool MAX_DOT_GRAPH_WIDTH.note =The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width (in pixels) of the graphs generated by dot.
If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.
MAX_DOT_GRAPH_HEIGHT.text = Maximum DOT Graph Height MAX_DOT_GRAPH_HEIGHT.group = dot Tool MAX_DOT_GRAPH_HEIGHT.note =The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height (in pixels) of the graphs generated by dot.
If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.
MAX_DOT_GRAPH_DEPTH.text = Maximum DOT Graph Depth MAX_DOT_GRAPH_DEPTH.group = dot Tool MAX_DOT_GRAPH_DEPTH.note =The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs generated by dot. A depth value of 3 means that only nodes reachable from the root by following a path via at most 3 edges will be shown. Nodes that lay further from the root node will be omitted.
Note that setting this option to 1 or 2 may greatly reduce the computation time needed for large code bases.
Also note that a graph may be further truncated if the graph's image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), the graph is not depth-constrained.
DOT_GRAPH_MAX_NODES.text = DOT Graph Max Nodes DOT_GRAPH_MAX_NODES.group = dot Tool DOT_GRAPH_MAX_NODES.type = text DOT_GRAPH_MAX_NODES.note =The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes that will be shown in the graph.
If the number of nodes in a graph becomes larger than this value, doxygen will truncate the graph, which is visualized by representing a node as a red box. Note that doxygen will always show the root nodes and its direct children regardless of this setting.
DOT_TRANSPARENT.text = DOT Transparent DOT_TRANSPARENT.group = dot Tool DOT_TRANSPARENT.type = boolean DOT_TRANSPARENT.note =Set the DOT_TRANSPARENT tag to YES to generate images with a transparent background. This is disabled by default, which results in a white background.
Warning: Depending on the platform used, enabling this option may lead to badly anti-aliased labels on the edges of a graph (i.e. they become hard to read).
DOT_MULTI_TARGETS.text = DOT Multi Targets DOT_MULTI_TARGETS.group = dot Tool DOT_MULTI_TARGETS.type = boolean DOT_MULTI_TARGETS.note =Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output files in one run (i.e. multiple -o and -T options on the command line).
This makes dot run faster, but since only newer versions of dot (>1.8.10) support this, this feature is disabled by default.
GENERATE_LEGEND.text = Generate Legend GENERATE_LEGEND.group = dot Tool GENERATE_LEGEND.type = boolean GENERATE_LEGEND.note = If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs. DOT_CLEANUP.text = DOT Clean-up DOT_CLEANUP.group = dot Tool DOT_CLEANUP.type = boolean DOT_CLEANUP.note = If the DOT_CLEANUP tag is set to YES (the default) Doxygen will remove the intermediate dot files that are used to generate the various graphs. #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE.text = Search Engine SEARCHENGINE.type = boolean SEARCHENGINE.note = The SEARCHENGINE tag specifies whether or not a search engine should be used. If set to NO the values of all tags below this one will be ignored. eclox/eclox.core/plugin.xml 0000644 0001750 0000144 00000003521 10601517167 015335 0 ustar willy userstrue or false
*/
public static boolean isDoxyfile(IResource resource) {
return (resource instanceof IFile) && isDoxyfile((IFile) resource);
}
/**
* Tells if the specified file is a doxyfile.
*
* @param file the file to test
*
* @return true or false
*/
public static boolean isDoxyfile(IFile file) {
String name = file.getName();
IContentType contentType = Platform.getContentTypeManager().findContentTypeFor( name );
return contentType != null ? contentType.getId().equals("org.gna.eclox.core.doxyfile") : false;
}
/**
* Constructor
*
* @param file a file resource instance that is assumed to be a doxyfile
*/
public Doxyfile( IFile file ) throws IOException, CoreException {
this.file = file;
Parser parser = new Parser(file.getContents());
parser.read( this );
}
/**
* Appends a new chunk to the doxyfile.
*
* @param chunk a chunk to append to the doxyfile
*/
public void append( Chunk chunk ) {
// Pre-condition
assert chunk.getOwner() == null;
// References the chunk.
chunk.setOwner( this );
this.chunks.add( chunk );
// Do special handling for settings.
if( chunk instanceof Setting ) {
Setting setting = (Setting) chunk;
this.settings.put( setting.getIdentifier(), setting );
// Retrieves the setting group name.
String groupName = setting.getProperty( Setting.GROUP );
if( groupName == null ) {
groupName = new String( "Others" );
setting.setProperty( Setting.GROUP, groupName );
}
// Retrieves the setting group and stores the setting in it.
Group group = (Group) this.groups.get( groupName );
if( group == null ) {
group = new Group( groupName );
this.groups.put( groupName, group );
}
group.add( setting );
}
}
/**
* Retrieves the resource file that contains the doxyfile.
*
* @return a resource file
*/
public IFile getFile() {
return file;
}
/**
* Retrieves all groups present in the doxyfile.
*
* @return an array containing all groups
*/
public Object[] getGroups() {
return this.groups.values().toArray();
}
/**
* Retrieves the last appended chunk
*
* @return the last added chunk or null if none
*/
public Chunk getLastChunk() {
if( this.chunks.isEmpty() == false ) {
return (Chunk) this.chunks.get( this.chunks.size() - 1 );
}
else {
return null;
}
}
/**
* Retrieves the container that will receive the documentation build outputs.
*
* @return a folder, or null when none
*/
public IContainer getOutputContainer() {
IContainer outputContainer = null;
Setting outputSetting = getSetting("OUTPUT_DIRECTORY");
if( outputSetting != null ) {
Path outputPath = new Path(outputSetting.getValue());
if( outputPath.isEmpty() ) {
outputContainer = file.getParent();
}
else if( outputPath.isAbsolute() ) {
IContainer[] foundContainers = ResourcesPlugin.getWorkspace().getRoot().findContainersForLocation(outputPath);
outputContainer = foundContainers.length == 1 ? foundContainers[0] : null;
}
else {
IPath fullOutputPath = file.getParent().getLocation().append(outputPath);
IContainer[] foundContainers = ResourcesPlugin.getWorkspace().getRoot().findContainersForLocation(fullOutputPath);
outputContainer = foundContainers.length == 1 ? foundContainers[0] : null;
}
}
return outputContainer;
}
/**
* Retrieves a single setting for the specified identifier.
*
* @param identifier a string containing a setting identifier
*
* @return the found setting or null if none
*/
public Setting getSetting( String identifier ) {
return (Setting) settings.get(identifier);
}
/**
* Retrieves all settings as an array
*
* @return an array of settings
*/
public Object[] getSettings() {
return settings.values().toArray();
}
/**
* Tells if the doxyfile has the given setting.
*
* @param identifier a string containing a setting identifier
*
* @return true or false
*/
public boolean hasSetting( String identifier ) {
return settings.get(identifier) != null;
}
/**
* Tells if the given path is relative to the doxyfile.
*
* @return true or false
*/
public boolean isPathRelative( IPath path ) {
return file.getLocation().removeLastSegments(1).isPrefixOf( path );
}
/**
* Makes the given path relative to the doxyfile path only of the given
* path point to a location that is in the sub-directory containing the
* doxyfile.
*
* @return the argument path made relative to the doxyfile
*/
public IPath makePathRelative( IPath path ) {
if( isPathRelative(path) ) {
int matchingCount = file.getLocation().removeLastSegments(1).matchingFirstSegments( path );
IPath relativePath = path.removeFirstSegments( matchingCount ).setDevice( new String() );
return relativePath.isEmpty() ? new Path(".") : relativePath;
}
else {
return path;
}
}
/**
* Retrieves the iterator the whole chunk collection.
*
* @return an iterator on chunks
*/
public Iterator iterator() {
return this.chunks.iterator();
}
/**
* Retrieves the iterator on the setting collection.
*
* @return an iterator on Setting instances
*/
public Iterator settingIterator() {
return settings.values().iterator();
}
}
eclox/eclox.core/src/eclox/core/doxyfiles/ISettingPropertyListener.java 0000644 0001750 0000144 00000002462 12166012446 026021 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2005, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles;
/**
* Derfines the interface for listeners receiving notifications about property changes.
*
* @author gbrocker
*/
public interface ISettingPropertyListener extends ISettingListener {
/**
* Notifies that a setting property has been added or its has changed.
*
* @param setting the setting that raised the event
* @param property a string containing a property name
*/
void settingPropertyChanged( Setting setting, String property );
/**
* Notifies that a setting property has been removed.
*
* @param setting the setting that raised the event
* @param property a string containing a property name
*/
void settingPropertyRemoved( Setting setting, String property );
}
eclox/eclox.core/src/eclox/core/doxyfiles/Group.java 0000644 0001750 0000144 00000003273 12166012446 022115 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2005, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles;
import java.util.Collection;
import java.util.Iterator;
import java.util.Vector;
/**
* Implements a group of settings.
*
* @author gbrocker
*/
public class Group {
/**
* a string containing the group name
*/
private String name;
/**
* a collection of all settings in the group
*/
private Collection settings = new Vector();
/**
* Constructor
*
* @param name a string containing the group name
*/
public Group( String name ) {
this.name = new String( name );
}
/**
* Addes a new setting in the group.
*
* @param setting a setting to add to the group
*/
public void add( Setting setting ) {
settings.add( setting );
}
/**
* Retrieves the group name.
*
* @return a string containing the group name
*/
public String getName() {
return new String( this.name );
}
/**
* Retrieves an iterator on all managed settings.
*
* @return an iterator
*/
public Iterator iterator() {
return settings.iterator();
}
}
eclox/eclox.core/src/eclox/core/doxyfiles/io/ 0000755 0001750 0000144 00000000000 12315037713 020560 5 ustar willy users eclox/eclox.core/src/eclox/core/doxyfiles/io/Parser.java 0000644 0001750 0000144 00000023015 12166012446 022660 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2004, 2008, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles.io;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
//import eclox.core.Services;
import eclox.core.Plugin;
import eclox.core.doxyfiles.Chunk;
import eclox.core.doxyfiles.Doxyfile;
import eclox.core.doxyfiles.RawText;
import eclox.core.doxyfiles.Setting;
/**
* Implements a doxyfile parser.
*
* @author gbrocker
*/
public class Parser {
/**
* the current line number
*/
private int lineNumber = 0;
/**
* The line reader used to parse the input stream.
*/
private BufferedReader reader;
/**
* The comment line pattern.
*/
private Pattern commentPattern = Pattern.compile("#.*");
/**
* the empty line pattern
*/
private Pattern emptyPattern = Pattern.compile("\\s*");
/**
* the setting assignment pattern
*/
private Pattern settingAssignmentPattern = Pattern.compile("(\\w+)\\s*=\\s*(.*?)\\s*(\\\\)?");
/**
* the setting increment pattern
*/
private Pattern settingIncrementPattern = Pattern.compile("(\\w+)\\s*\\+=\\s*(.*?)\\s*(\\\\)?");
/**
* the continued setting assignment pattern
*/
private Pattern continuedSettingAssignmentPattern = Pattern.compile("\\s*(.+?)\\s*(\\\\)?");
/**
* the include directive pattern
*/
private Pattern includePattern = Pattern.compile("@INCLUDE\\s*=\\s*(.*)");
/**
* the include path pattern
*/
private Pattern includePathPattern = Pattern.compile("@INCLUDE_PATH\\s*=\\s*(.*)");
/**
* Constructor.
*
* @param input an input stream instance to parse as a doxyfile
*/
public Parser( InputStream input ) throws IOException {
this.reader = new BufferedReader( new InputStreamReader(input) );
this.reader.mark(0);
}
/**
* Reads the input stream and returns the doxyfile.
*
* @param doxyfile a doxyfile where the parser results will be stored
*
* @return a collection of the setting read from the input stream
*/
public void read( Doxyfile doxyfile ) throws IOException {
// Initialization of the system.
this.reader.reset();
this.lineNumber = 0;
// Reads and parses all lines.
try {
String line;
for( line = reader.readLine(); line != null; line = reader.readLine() ) {
lineNumber++;
this.matchLine( doxyfile, line );
}
}
catch(Throwable throwable) {
throw new IOException( "Syntax error at line " + lineNumber + ". " + throwable.getMessage() );
}
}
/**
* Matches the specified line.
*
* @param doxyfile a doxyfile where the result will be stored
* @param line a string containing the current line text
*/
private void matchLine( Doxyfile doxyfile, String line ) throws IOException {
Matcher matcher;
// Matches the current line against an empty line pattern
matcher = emptyPattern.matcher( line );
if( matcher.matches() == true ) {
this.processAnyLine( doxyfile, line );
return;
}
// Matches the current line against the comment pattern.
matcher = commentPattern.matcher( line );
if( matcher.matches() == true ) {
this.processAnyLine( doxyfile, line );
return;
}
// Matches the current line against the setting assignment pattern.
matcher = settingAssignmentPattern.matcher( line );
if( matcher.matches() == true ) {
// Retrieves the setting identifier and its values.
String identifier = matcher.group(1);
String values = matcher.group(2);
// Call the traitement for the setting assignment and pull out.
this.processSettingAssignment( doxyfile, identifier, values );
return;
}
// Matches the current line against the setting increment pattern.
matcher = settingIncrementPattern.matcher( line );
if( matcher.matches() == true ) {
// Retrieves the setting identifier and its values.
String identifier = matcher.group(1);
String values = matcher.group(2);
// Call the treatment for the setting assignment and pull out.
this.processSettingIncrement( doxyfile, identifier, values );
return;
}
// Matches the current line against the include directive pattern.
matcher = includePattern.matcher( line );
if( matcher.matches() == true ) {
this.processAnyLine( doxyfile, line );
return;
}
// Matches the current line agains the include path directive pattern.
matcher = includePathPattern.matcher( line );
if( matcher.matches() == true ) {
this.processAnyLine( doxyfile, line );
return;
}
// Matches the current line against the continued setting assignment pattern.
matcher = continuedSettingAssignmentPattern.matcher( line );
if( matcher.matches() == true ) {
// Retrieves the setting identifier and its values.
String values = matcher.group(1);
String continued = matcher.group(2);
// Call the treatment for the continued setting assignment and pull out.
this.processContinuedSettingAssignment( doxyfile, values, continued != null );
return;
}
// The line has not been recognized.
throw new IOException( "Unable to match line." );
}
/**
* Processes any line of a doxyfile that is not interesting and should only be stored
* for later use (saving for example).
*
* @param doxyfile a doxyfile where the line will be stored
* @param text a string containing the line text
*/
private void processAnyLine( Doxyfile doxyfile, String text ) {
// Retrieves the last raw text chunk.
Chunk lastChunk = doxyfile.getLastChunk();
RawText rawText;
if( lastChunk instanceof RawText ) {
rawText = (RawText) lastChunk;
}
else {
rawText = new RawText();
doxyfile.append( rawText );
}
// Stores the line's text in the raw text chunk.
rawText.append( text );
rawText.append( "\n" );
}
/**
* Processes a setting assignment line.
*
* @param doxyfile a doxyfile where the setting assignment will be stored
* @param identifier a string containing the setting identifier
* @param value a string containing the assigned value
*/
private void processSettingAssignment( Doxyfile doxyfile, String identifier, String value ) throws IOException {
// Retrieves the setting.
Setting setting = doxyfile.getSetting( identifier );
if( setting == null ) {
setting = new Setting( identifier, value );
doxyfile.append( setting );
}
// Updates the setting value.
setting.setValue( value );
}
/**
* Processes a setting increment line.
*
* @param doxyfile a doxyfile where the setting assignment will be stored
* @param identifier a string containing the setting identifier
* @param value a string containing the assigned value
*/
private void processSettingIncrement( Doxyfile doxyfile, String identifier, String value ) throws IOException {
// Retrieves the setting from the doxyfile.
Setting setting = doxyfile.getSetting( identifier );
if( setting != null ) {
// Updates the continued setting's value.
setting.setValue( setting.getValue() + " " + value );
}
else {
Plugin.getDefault().logWarning( "At line " + lineNumber + ": the setting was not declared before." );
processSettingAssignment( doxyfile, identifier, value );
}
}
/**
* Processes a setting assignment line.
*
* @param doxyfile a doxyfile where the setting assignment will be stored
* @param value a string containing the assigned value
* @param continued a boolean telling if the setting assignment is continued on multiple line
*/
private void processContinuedSettingAssignment( Doxyfile doxyfile, String value, boolean continued ) throws IOException {
Chunk lastChunk = doxyfile.getLastChunk();
// Ensures that a continued setting has been remembered
// and updates it.
if( lastChunk instanceof Setting ) {
Setting continuedSetting = (Setting) lastChunk;
continuedSetting.setValue( continuedSetting.getValue() + " " + value );
}
else {
Plugin.getDefault().logWarning( "At line " + lineNumber + ": value delcared without a setting name." );
}
}
}
eclox/eclox.core/src/eclox/core/doxyfiles/io/Serializer.java 0000644 0001750 0000144 00000004332 12166012446 023536 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2004, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles.io;
import java.io.IOException;
import java.io.InputStream;
import java.util.Iterator;
import eclox.core.doxyfiles.Chunk;
import eclox.core.doxyfiles.Doxyfile;
/**
* Implements a doxyfile content serializer.
*
* @author willy
*/
public class Serializer extends InputStream {
/**
* an iterator on the doxyfile chunks
*/
private Iterator chunkIterator;
/**
* a string buffer containing the next character to red
*/
private StringBuffer stringBuffer;
/**
* Constructor
*
* @param doxyfile a doxyfile to serialize
*/
public Serializer( Doxyfile doxyfile ) {
this.chunkIterator = doxyfile.iterator();
this.stringBuffer = getNextStringBuffer();
}
public int read() throws IOException {
int result;
if( stringBuffer != null ) {
// Retrieves the next character from the current string buffer.
result = stringBuffer.charAt( 0 );
stringBuffer.deleteCharAt( 0 );
// If the current string buffer has been entierly read, gets the next string buffer.
if( stringBuffer.length() == 0 ) {
stringBuffer = getNextStringBuffer();
}
}
else {
result = -1;
}
return result;
}
/**
* Retrieves the next string buffer to use for reading operations or null
* if no more chunk is left in the doxyfile.
*
* @return a string buffer or null of none
*/
private StringBuffer getNextStringBuffer() {
// Pre-condition
assert chunkIterator != null;
// Retrieves the next string buffer.
StringBuffer result = null;
if( this.chunkIterator.hasNext() == true ) {
Chunk chunk = (Chunk) this.chunkIterator.next();
result = new StringBuffer( chunk.toString() );
}
return result;
}
}
eclox/eclox.core/src/eclox/core/doxyfiles/Chunk.java 0000644 0001750 0000144 00000002514 12166012446 022066 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003, 2004, 2007, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles;
/**
* Implements the default item that can be contained in a doxyfile.
*
* A chunk is a piece of text extracted from e doxyfile. It can represent comments,
* empty lines or whatever.
*
* @author Guillaume Brocker
*/
public abstract class Chunk {
/**
* the chunk owner (aka the doxyfile)
*/
private Doxyfile owner;
/**
* Retrieves the chunk owner.
*
* @return the chunk owner
*/
public Doxyfile getOwner() {
return owner;
}
/**
* Updates the chunk owner
*
* @param owner the new owner
*/
public void setOwner( Doxyfile owner ) {
this.owner = owner;
}
/**
* Converts the chunk into a string representing its content.
*
* @return a string containing the chunk content
*/
public abstract String toString();
}
eclox/eclox.core/src/eclox/core/doxyfiles/Setting.java 0000644 0001750 0000144 00000022167 12166012446 022441 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2004, 2013 Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles;
import java.io.InputStream;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import java.util.Properties;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import eclox.core.Plugin;
import eclox.core.doxyfiles.Chunk;
/**
* Implements the setting chunk.
*
* @author gbrocker
*/
public class Setting extends Chunk {
/**
* The value pattern.
*/
private static Pattern valuePattern = Pattern.compile("([^ \"]+)\\s*|\"((\\\\\"|.)*?)\"\\s*");
/**
* The default setting properties.
*/
private static Properties defaultProperties;
/**
* A string containing the node identifier.
*/
private final String identifier;
/**
* A collection with all attached listeners
*/
private Set listeners = new HashSet();
/**
* The string containing the setting value.
*/
private String value;
/**
* The setting local properties.
*/
private Properties properties = new Properties();
/**
* Defines the group property name.
*/
public static final String GROUP = "group";
/**
* Defines the note property name.
*/
public static final String NOTE = "note";
/**
* Defines the text property name.
*/
public static final String TEXT = "text";
/**
* Defines the type property name.
*/
public static final String TYPE = "type";
/**
* Initializes all setting default properties.
*/
private static void initDefaultProperties() {
// Ensures that properties have been loaded.
if( defaultProperties == null ) {
try {
InputStream propertiesInput = Plugin.class.getResourceAsStream("/misc/setting-properties.txt");
defaultProperties = new Properties();
defaultProperties.load( propertiesInput );
}
catch( Throwable throwable ) {
Plugin.log( throwable );
}
}
}
/**
* Retrieves the specified default property given a setting.
*
* @param setting a setting instance
* @param property a string containing the name of the property to retrieve.
*
* @return a string containing the desired property value or null when
* no such property exists
*/
private static String getDefaultPropertyValue( Setting setting, String property ) {
initDefaultProperties();
String propertyIdentifier = setting.getIdentifier() + "." + property;
return defaultProperties.getProperty( propertyIdentifier );
}
/**
* Constructor.
*
* @param identifier a string containing the setting identifier
* @param value a string containing the setting value
*/
public Setting(String identifier, String value) {
this.identifier = new String(identifier);
this.value = new String(value);
}
/**
* Attaches a new setting listener instance.
*
* @param listener a new setting listener instance
*/
public void addSettingListener(ISettingListener listener) {
this.listeners.add( listener );
}
/**
* Retrieves the node identifier.
*
* @return a string containing the node identifier
*/
public final String getIdentifier() {
return this.identifier;
}
/**
* Retrieves the value of the specified property.
*
* @param property a string containing a property name
*
* @return a string containing the property value or null when the property was not found
*/
public String getProperty( String property ) {
if( properties.containsKey( property) ) {
return properties.getProperty( property );
}
else {
return getDefaultPropertyValue( this, property );
}
}
/**
* Retrieves the setting value.
*
* @return a string containing the setting value
*/
public String getValue() {
return value;
}
/**
* Retrieves the splitted setting value.
*
* @param collection a collection instance that will receive the value parts
*
* @return the collection that received the value parts
*/
public Collection getSplittedValue(Collection collection) {
Matcher valueMatcher = valuePattern.matcher(value);
while( valueMatcher.find() == true ) {
String value = valueMatcher.group( 1 );
if( value == null ) {
value = valueMatcher.group( 2 ).trim();
}
collection.add( value );
}
return collection;
}
/**
* Tells if the setting has the givgen property set.
*
* @param property a string containing a property name
*
* @return a boolean
*/
public boolean hasProperty( String property ) {
if( properties.containsKey( property) ) {
return true;
}
else {
return getDefaultPropertyValue( this, property ) != null;
}
}
/**
* Detaches a new setting listener instance.
*
* @param listener a attached setting listener instance
*/
public void removeSettingListener(ISettingListener listener) {
this.listeners.remove( listener );
}
/**
* Updates the value of a given property.
*
* @param property a string containing the name of property
* @param value a string containing the property value
*/
public void setProperty( String property, String value ) {
// Updates the given property.
properties.setProperty( property, value );
// Walks through the attached listeners and notify them.
Iterator i = this.listeners.iterator();
while( i.hasNext() == true ) {
ISettingListener listener = (ISettingListener) i.next();
if( listener instanceof ISettingPropertyListener ) {
ISettingPropertyListener propertyListener = (ISettingPropertyListener) listener;
propertyListener.settingPropertyChanged( this, property );
}
}
}
/**
* Removes the given property for the setting.
*
* @param property a string containing a property name
*/
public void removeProperty( String property ) {
if( properties.containsKey( property ) ) {
properties.remove( property );
// Walks through the attached listeners and notify them.
Iterator i = this.listeners.iterator();
while( i.hasNext() == true ) {
ISettingListener listener = (ISettingListener) i.next();
if( listener instanceof ISettingPropertyListener ) {
ISettingPropertyListener propertyListener = (ISettingPropertyListener) listener;
propertyListener.settingPropertyRemoved( this, property );
}
}
}
}
/**
* Updates the value of the setting.
*
* @param value a string representing a value to set
*/
public void setValue(String value) {
this.value = new String(value);
fireValueChangedEvent();
}
/**
* Updates the value of the string with the given object collection. All objects
* of the given collection will be converted to strings.
*
* @param compounds a collection of objects representing compounds of the new value
*/
public void setValue( Collection compounds ) {
// Resets the managed value string.
value = new String();
// Walks through the comounds to rebuild the value.
Iterator i = compounds.iterator();
while( i.hasNext() ) {
// Retrieves the current compound.
String compound = i.next().toString();
// Removes any leading and tralling spaces and manage the insertion.
compound = compound.trim();
if( compound.length() == 0 ) {
continue;
}
else if( compound.indexOf(' ') != -1 ) {
value = value.concat( "\"" + compound + "\" " );
}
else {
value = value.concat( compound + " " );
}
}
// Notifies all observers.
fireValueChangedEvent();
}
public String toString() {
return this.identifier + " = " + this.value + "\n";
}
/**
* Notifies all observers that the setting value has changed.
*/
private void fireValueChangedEvent() {
Iterator i = listeners.iterator();
while( i.hasNext() == true ) {
ISettingListener listener = (ISettingListener) i.next();
if( listener instanceof ISettingValueListener ) {
ISettingValueListener valueListener = (ISettingValueListener) listener;
valueListener.settingValueChanged( this );
}
}
}
}
eclox/eclox.core/src/eclox/core/doxyfiles/ISettingValueListener.java 0000644 0001750 0000144 00000001646 12166012446 025254 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2005, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles;
/**
* Defines the interface for listener listening for setting value changes.
*
* @author gbrocker
*/
public interface ISettingValueListener extends ISettingListener {
/**
* Notifies that a setting value changed.
*
* @param setting the setting that raised the event
*/
void settingValueChanged( Setting setting );
}
eclox/eclox.core/src/eclox/core/doxyfiles/ISettingListener.java 0000644 0001750 0000144 00000001347 12166012446 024255 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2005, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.doxyfiles;
/**
* Defines the interface for objects that want to receive information about
* setting changes.
*
* @author gbrocker
*/
public interface ISettingListener {}
eclox/eclox.core/src/eclox/core/Plugin.java 0000644 0001750 0000144 00000004357 12166012446 020255 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2006, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core;
import org.eclipse.core.runtime.Status;
import org.osgi.framework.BundleContext;
/**
* Implements the core eclox plugin
*
* @author gbrocker
*/
public class Plugin extends org.eclipse.core.runtime.Plugin {
/**
* the default plugin instance
*/
private static Plugin plugin;
/**
* The constructor.
*/
public Plugin() {
plugin = this;
}
/**
* This method is called upon plug-in activation
*/
public void start(BundleContext context) throws Exception {
super.start(context);
}
/**
* This method is called when the plug-in is stopped
*/
public void stop(BundleContext context) throws Exception {
super.stop(context);
plugin = null;
}
/**
* Returns the shared instance.
*/
public static Plugin getDefault() {
return plugin;
}
/**
* Adds the specified message into the plugin's log as a warning.
*
* @param message a string containing a message to log as a warning
*/
public void logWarning( String message ) {
getLog().log( new Status(Status.WARNING, getBundle().getSymbolicName(), 0, message, null) );
}
/**
* Adds the specified message into the plugin's log as an error.
*
* @param message a string containing a message to log as an error
*/
public void logError( String message ) {
getLog().log( new Status(Status.ERROR, getBundle().getSymbolicName(), 0, message, null) );
}
/**
* Adds the specified throwable object into the plugin's log as an error.
*
* @param throwable a throwable instance to log
*/
public static void log( Throwable throwable ) {
plugin.getLog().log( new Status(Status.ERROR, plugin.getBundle().getSymbolicName(), 0, "Exception caught. " + throwable.toString(), throwable) );
}
}
eclox/eclox.core/src/eclox/core/ui/ 0000755 0001750 0000144 00000000000 12315037713 016560 5 ustar willy users eclox/eclox.core/src/eclox/core/ui/build_co.gif 0000644 0001750 0000144 00000000270 10642715532 021031 0 ustar willy users GIF89a J#J"K"L#M$RZ80]UXV`OgQoMrTxlvajҨТװܴ!
, 5y$)R:VA%lTc L! a$eEvE! ; eclox/eclox.core/src/eclox/core/ui/DoxyfileDecorator.java 0000644 0001750 0000144 00000010325 12166012446 023052 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2007, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.ui;
import java.util.Collection;
import java.util.Iterator;
import java.util.Vector;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.jobs.IJobChangeEvent;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.core.runtime.jobs.JobChangeAdapter;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.IDecoration;
import org.eclipse.jface.viewers.ILabelProviderListener;
import org.eclipse.jface.viewers.ILightweightLabelDecorator;
import org.eclipse.jface.viewers.LabelProviderChangedEvent;
import eclox.core.doxyfiles.Doxyfile;
import eclox.core.doxygen.BuildJob;
public class DoxyfileDecorator implements ILightweightLabelDecorator {
/**
* Implements a job change listener
*/
/**
* @author gbrocker
*
*/
private class MyJobListener extends JobChangeAdapter {
/**
* @see org.eclipse.core.runtime.jobs.JobChangeAdapter#done(org.eclipse.core.runtime.jobs.IJobChangeEvent)
*/
public void done(IJobChangeEvent event) {
Job job = event.getJob();
if( job.belongsTo(BuildJob.FAMILY) ) {
BuildJob buildJob = (BuildJob) job;
fireProviderChangedEvent( buildJob.getDoxyfile() );
}
}
/**
* @see org.eclipse.core.runtime.jobs.JobChangeAdapter#running(org.eclipse.core.runtime.jobs.IJobChangeEvent)
*/
public void running(IJobChangeEvent event) {
Job job = event.getJob();
if( job.belongsTo(BuildJob.FAMILY) ) {
BuildJob buildJob = (BuildJob) job;
fireProviderChangedEvent( buildJob.getDoxyfile() );
}
}
}
/**
* the collection of attached listeners
*/
private Collection listeners = new Vector();
/**
* the job listener
*/
private MyJobListener jobManagerListener = new MyJobListener();
/**
* Constructor
*/
public DoxyfileDecorator() {
Job.getJobManager().addJobChangeListener(jobManagerListener);
}
/**
* @see org.eclipse.jface.viewers.ILightweightLabelDecorator#decorate(java.lang.Object, org.eclipse.jface.viewers.IDecoration)
*/
public void decorate(Object element, IDecoration decoration) {
if( Doxyfile.isDoxyfile(element) ) {
IFile doxyfile = (IFile) element;
BuildJob job = BuildJob.findJob(doxyfile);
if( job != null && job.getState() == BuildJob.RUNNING ) {
decoration.addOverlay( ImageDescriptor.createFromFile(this.getClass(), "build_co.gif"), IDecoration.BOTTOM_LEFT );
decoration.addSuffix(" (building...)");
}
}
}
/**
* @see org.eclipse.jface.viewers.IBaseLabelProvider#addListener(org.eclipse.jface.viewers.ILabelProviderListener)
*/
public void addListener(ILabelProviderListener listener) {
listeners.add(listener);
}
/**
* @see org.eclipse.jface.viewers.IBaseLabelProvider#dispose()
*/
public void dispose() {
Job.getJobManager().removeJobChangeListener(jobManagerListener);
}
/**
* @see org.eclipse.jface.viewers.IBaseLabelProvider#isLabelProperty(java.lang.Object, java.lang.String)
*/
public boolean isLabelProperty(Object element, String property) {
return false;
}
/**
* @see org.eclipse.jface.viewers.IBaseLabelProvider#removeListener(org.eclipse.jface.viewers.ILabelProviderListener)
*/
public void removeListener(ILabelProviderListener listener) {
listeners.remove(listener);
}
/**
* Notifies listerners that the given resource'l decoration need to be updated
*
* @param resource a resource to refresh
*/
private void fireProviderChangedEvent( Object resource ) {
Iterator i = listeners.iterator();
LabelProviderChangedEvent event = new LabelProviderChangedEvent(this, resource);
while( i.hasNext() ) {
ILabelProviderListener listener = (ILabelProviderListener) i.next();
listener.labelProviderChanged(event);
}
}
}
eclox/eclox.core/src/eclox/core/ui/PreferencePage.java 0000644 0001750 0000144 00000004431 12166012446 022300 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2007, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.ui;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.eclipse.ui.preferences.ScopedPreferenceStore;
import eclox.core.Plugin;
/**
* Implements the preferences for the core eclox plug-in.
*
* @author gbrocker
*/
public class PreferencePage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {
public static final String ID = "eclox.core.PreferencePage"; ///< Holds the identifier of the property page.
public PreferencePage() {
super( GRID );
}
/**
* @see org.eclipse.ui.IWorkbenchPreferencePage#init(org.eclipse.ui.IWorkbench)
*/
public void init(IWorkbench workbench) {
setPreferenceStore( new ScopedPreferenceStore( new InstanceScope(), Plugin.getDefault().getBundle().getSymbolicName() ) );
}
/**
* @see org.eclipse.jface.preference.FieldEditorPreferencePage#createFieldEditors()
*/
protected void createFieldEditors() {
// Creates all control instances.
Label doxygenLabel = new Label( getFieldEditorParent(), SWT.WRAP );
DefaultDoxygenFieldEditor doxygen = new DefaultDoxygenFieldEditor( getFieldEditorParent() );
// Configures field editors.
addField( doxygen );
// Configures the default doxygen label.
GridData doxygenLabelData = new GridData();
doxygenLabelData.horizontalSpan = 3;
doxygenLabelData.horizontalAlignment = SWT.FILL;
doxygenLabel.setText( "Choose among available doxygen versions, the one you would like to use." );
doxygenLabel.setLayoutData( doxygenLabelData );
}
}
eclox/eclox.core/src/eclox/core/ui/DefaultDoxygenFieldEditor.java 0000644 0001750 0000144 00000033160 12166012446 024463 0 ustar willy users /*******************************************************************************
* Copyright (C) 2003-2006, 2013, Guillaume Brocker
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Guillaume Brocker - Initial API and implementation
*
******************************************************************************/
package eclox.core.ui;
import java.util.Collection;
import java.util.Iterator;
import java.util.Vector;
import org.eclipse.jface.preference.FieldEditor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.DirectoryDialog;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.PlatformUI;
import eclox.core.IPreferences;
import eclox.core.Plugin;
import eclox.core.doxygen.BundledDoxygen;
import eclox.core.doxygen.CustomDoxygen;
import eclox.core.doxygen.DefaultDoxygen;
import eclox.core.doxygen.Doxygen;
/**
* @author Guillaume Brocker
*/
public class DefaultDoxygenFieldEditor extends FieldEditor {
/**
* defines the version column index
*/
private final int VERSION_COLUMN_INDEX = 0;
/**
* defines the type column index
*/
private final int TYPE_COLUMN_INDEX = 1;
/**
* defines the description column index
*/
private final int DESCRIPTION_COLUMN_INDEX = 2;
/**
* the table control showing available doxygen wrappers
*/
private Table table;
/**
* the composite containing all buttons
*/
private Composite buttons;
/**
* the button that triggers the addition of a custom doxygen
*/
private Button add;
/**
* the button that triggers the edition of a custom doxygen
*/
private Button edit;
/**
* the button that triggers the removal of a custom doxygen
*/
private Button remove;
/**
* the valid state of the field editor
*/
private boolean valid = true;
/**
* Implements a selection listener for the owned table control.
*
* It is reponsible to ensure that only one table item is selected at a time
* and it also fires value change notifications.
*/
private class MySelectionListener implements SelectionListener {
/**
* @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent)
*/
public void widgetDefaultSelected(SelectionEvent e) {
widgetSelected( e );
}
/**
* @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
*/
public void widgetSelected(SelectionEvent e) {
if (e.item instanceof TableItem ) onItemSelected( (TableItem) e.item );
else if (e.getSource() == add ) onAddSelected();
else if (e.getSource() == edit) onEditSelected();
else if (e.getSource() == remove) onRemoveSelected();
}
}
/**
* Adds a new table item for the given doxygen instance
*/
private void addItem( Doxygen doxygen ) {
TableItem item = new TableItem( table, 0 );
item.setData( doxygen );
updateItem( item );
}
/**
* Retrieves the type of the given doxygen wrapper instance
*/
private static String getDoxygenType( final Doxygen doxygen ) {
if ( doxygen instanceof DefaultDoxygen ) return "Default";
else if ( doxygen instanceof CustomDoxygen ) return "Custom";
else if ( doxygen instanceof BundledDoxygen ) return "Bundled";
else return "Uknown";
}
/**
* Updates the given table item.
*/
private void updateItem( TableItem item ) {
// Item data preparation.
final Doxygen doxygen = (Doxygen) item.getData();
final String type = getDoxygenType( doxygen );
final String version = doxygen.getVersion();
final String description = doxygen.getDescription();
// Updates the item properties.
item.setImage( (version == null) ? PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_OBJS_WARN_TSK) : null );
item.setText( VERSION_COLUMN_INDEX, (version == null) ? "unknown" : version );
item.setText( TYPE_COLUMN_INDEX, type );
item.setText( DESCRIPTION_COLUMN_INDEX, description );
// Updates the table layout.
table.getColumn( VERSION_COLUMN_INDEX ).pack();
table.getColumn( TYPE_COLUMN_INDEX ).pack();
table.getColumn( DESCRIPTION_COLUMN_INDEX ).pack();
table.layout();
}
/**
* Checkes the table item representing the given doxygen identifier.
*/
private void checkItem( final String identifier ) {
TableItem[] items = table.getItems();
for( int i = 0; i < items.length; ++i ) {
Doxygen current = (Doxygen) items[i].getData();
items[i].setChecked( current.getIdentifier().equalsIgnoreCase( identifier ) );
}
}
/**
* Retrieves checked items.
*
* @return the checked item or null if none
*/
private TableItem[] getCheckedItems() {
// Pre-condition
assert( table != null );
Vector checked = new Vector();
TableItem[] items = table.getItems();
for( int i = 0; i < items.length; ++i ) {
if( items[i].getChecked() == true ) {
checked.add( items[i] );
}
}
return (TableItem[]) checked.toArray( new TableItem[0] );
}
/**
* Process the click on the add button.
*/
private void onAddSelected() {
// Asks the user to select a location containing a doxygen binary.
DirectoryDialog dialog = new DirectoryDialog( getPage().getShell() );
String directory = null;
dialog.setMessage( "Select a location containing doxygen." );
dialog.setText( "Add Custom Doxygen" );
directory = dialog.open();
// Creates the new wrapper.
if( directory != null ) {
addItem( new CustomDoxygen( directory ) );
}
}
/**
* Process the click on the edit button
*/
private void onEditSelected() {
// Pre-condition
assert( table != null );
// Retrieves the checked items
TableItem[] selected = table.getSelection();
// Retrieves the doxygen wrapper associated to the selected item
assert( selected.length == 1 );
Doxygen doxygen = (Doxygen) selected[0].getData();
// Asks the user to select a location containing a doxygen binary.
assert( doxygen instanceof CustomDoxygen );
CustomDoxygen customDoxygen = (CustomDoxygen) doxygen;
DirectoryDialog dialog = new DirectoryDialog( getPage().getShell() );
String directory = null;
dialog.setMessage( "Select a new location containing doxygen." );
dialog.setText( "Edit Custom Doxygen" );
dialog.setFilterPath( customDoxygen.getLocation() );
directory = dialog.open();
// Creates the new wrapper.
if( directory != null ) {
customDoxygen.setLocation( directory );
updateItem( selected[0] );
}
}
/**
* Process the click on the remove button
*/
private void onRemoveSelected() {
// Pre-condition
assert( table != null );
table.remove( table.getSelectionIndex() );
refreshValidState();
}
/**
* Process the selection of the given table item.
*/
private void onItemSelected( TableItem item ) {
if( item.getChecked() == true ) {
TableItem[] checked = getCheckedItems();
// Updates chekced items so that only one is chekced at the same time.
for( int i = 0; i < checked.length; ++i ) {
if( checked[i] != item ) {
checked[i].setChecked( false );
}
}
// Selects the item that has been checked.
table.setSelection( table.indexOf(item) );
// TODO only supported in eclipse 3.2
// table.setSelection( item );
// Fires some notifications.
fireValueChanged( VALUE, null, null );
}
// Updates button states
final boolean enable = item.getData() instanceof CustomDoxygen;
edit.setEnabled( enable );
remove.setEnabled( enable );
// Refreshes the field validity.
refreshValidState();
}
/**
* @see org.eclipse.jface.preference.FieldEditor#adjustForNumColumns(int)
*/
protected void adjustForNumColumns(int numColumns) {
// Pre-condition
assert( table != null );
GridData tableData = (GridData) table.getLayoutData();
GridData buttonsData = (GridData) buttons.getLayoutData();
tableData.horizontalSpan = numColumns - 1;
buttonsData.horizontalSpan = 1;
}
/**
* @see org.eclipse.jface.preference.FieldEditor#doFillIntoGrid(org.eclipse.swt.widgets.Composite, int)
*/
protected void doFillIntoGrid(Composite parent, int numColumns) {
// Pre-condition
assert( table == null );
// Creates the combo controls containing all available doxygen wrappers.
GridData tableData = new GridData( GridData.FILL_BOTH );
table = new Table( parent, SWT.SINGLE|SWT.CHECK|SWT.BORDER|SWT.FULL_SELECTION );
tableData.horizontalSpan = numColumns - 1;
table.setLayoutData( tableData );
table.addSelectionListener( new MySelectionListener() );
TableColumn versionColumn = new TableColumn( table, SWT.LEFT, VERSION_COLUMN_INDEX );
TableColumn typeColumn = new TableColumn( table, SWT.LEFT, TYPE_COLUMN_INDEX );
TableColumn descriptionColumn = new TableColumn( table, SWT.LEFT, DESCRIPTION_COLUMN_INDEX );
versionColumn.setText( "Version" );
typeColumn.setText( "Type" );
descriptionColumn.setText( "Description" );
table.setHeaderVisible( true );
// Creates the composite containing all buttons and located on the right side of the table.
GridData buttonsData = new GridData( GridData.END );
FillLayout buttonsLayout = new FillLayout( SWT.VERTICAL );
buttons = new Composite( parent, SWT.NO_FOCUS );
buttonsData.horizontalSpan = 1;
buttonsData.horizontalAlignment = SWT.FILL;
buttons.setLayoutData( buttonsData );
buttonsLayout.spacing = 5;
buttons.setLayout( buttonsLayout );
// Creates the button controlling custom doyxgen wrappers.
add = new Button( buttons, SWT.PUSH );
edit = new Button( buttons, SWT.PUSH );
remove = new Button( buttons, SWT.PUSH );
add.setText( "Add..." );
add.addSelectionListener( new MySelectionListener() );
edit.setText( "Edit..." );
edit.addSelectionListener( new MySelectionListener() );
edit.setEnabled( false );
remove.setText( "Remove" );
remove.addSelectionListener( new MySelectionListener() );
remove.setEnabled( false );
}
/**
* @see org.eclipse.jface.preference.FieldEditor#doLoad()
*/
protected void doLoad() {
// Adds default doxygen instance.
addItem( new DefaultDoxygen() );
// Adds custom doxygens.
final String raw = getPreferenceStore().getString( IPreferences.CUSTOM_DOXYGENS );
final String[] splitted = raw.split( "\n");
for( int i = 0; i < splitted.length; ++i ) {
CustomDoxygen doxygen = CustomDoxygen.createFromIdentifier( splitted[i] );
if( doxygen != null ) {
addItem( doxygen );
}
else {
Plugin.getDefault().logError( splitted[i] + ": invalid custom doxygen identifier found." );
}
}
// Adds bundled doxygens.
Collection bundled = BundledDoxygen.getAll();
Iterator i = bundled.iterator();
while( i.hasNext() ) {
addItem( (Doxygen) i.next() );
}
// Select the default doxygen wrapper
checkItem( getPreferenceStore().getString( IPreferences.DEFAULT_DOXYGEN ) );
}
/**
* @see org.eclipse.jface.preference.FieldEditor#doLoadDefault()
*/
protected void doLoadDefault() {
// Adds default doxygen instance.
addItem( new DefaultDoxygen() );
// Select the default doxygen wrapper
checkItem( getPreferenceStore().getDefaultString( IPreferences.DEFAULT_DOXYGEN ) );
}
/**
* @see org.eclipse.jface.preference.FieldEditor#doStore()
*/
protected void doStore() {
// Pre-condition
assert( table != null );
// Saves all custom doxygen wrappers.
TableItem[] items = table.getItems();
String serialized = new String();
for( int i = 0; i < items.length; ++i ) {
Object itemData = items[i].getData();
if( itemData instanceof CustomDoxygen ) {
CustomDoxygen doxygen = (CustomDoxygen) itemData;
serialized = serialized.concat( doxygen.getIdentifier() );
serialized = serialized.concat( "\n" );
}
}
getPreferenceStore().setValue( IPreferences.CUSTOM_DOXYGENS, serialized );
// Saves the checked item.
TableItem[] checked = getCheckedItems();
String defaultDoxygen = new String();
if( checked.length == 1 ) {
Doxygen doxygen = (Doxygen) checked[0].getData();
defaultDoxygen = doxygen.getIdentifier();
}
getPreferenceStore().setValue( IPreferences.DEFAULT_DOXYGEN, defaultDoxygen );
}
/**
* @see org.eclipse.jface.preference.FieldEditor#refreshValidState()
*/
protected void refreshValidState() {
TableItem[] checked = getCheckedItems();
boolean oldValid = valid;
boolean newValid = checked.length == 1;
// Updates validity and error message.
valid = newValid;
if( valid == false ) {
showErrorMessage( "Select the doxygen version to use." );
}
else {
clearErrorMessage();
}
// Send some notifications.
if( newValid != oldValid ) {
fireStateChanged( IS_VALID, oldValid, newValid );
}
}
/**
* Constructor
*/
public DefaultDoxygenFieldEditor( Composite parent ) {
super( IPreferences.DEFAULT_DOXYGEN, "Doxygen:", parent );
}
/**
* @see org.eclipse.jface.preference.FieldEditor#getNumberOfControls()
*/
public int getNumberOfControls() {
return 2;
}
/**
* @see org.eclipse.jface.preference.FieldEditor#isValid()
*/
public boolean isValid() {
return valid;
}
/**
* @see org.eclipse.jface.preference.FieldEditor#setFocus()
*/
public void setFocus() {
super.setFocus();
table.setFocus();
}
}
eclox/eclox.core/.classpath 0000644 0001750 0000144 00000000454 10405231037 015271 0 ustar willy users