1 / 9

Enhancing Eclipse with Custom Plug-ins and Extension Points

This document explores the architecture of Eclipse plug-ins, focusing on the implementation of extension points which allow plug-ins to define new functionality that others can utilize. It details the XML description within plugin.xml and the process of programmatically loading extensions. The text illustrates how to organize plugins and features effectively within products, emphasizing crucial dependencies for smooth operations. Key examples include BOY widgets and various CS-Studio products. Guidance for creating custom Eclipse-based products and managing dependencies is also provided.

jenette-miller
Download Presentation

Enhancing Eclipse with Custom Plug-ins and Extension Points

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Eclipse Products, Features, Plugins, Extension Points Kay Kasemir, Xihui Chen ORNL/SNS chenx1@ornl.gov 2012, April at SLAC

  2. Eclipse Plugin Architecture plug-in • Extension Point: defines new function point that other plug-ins can plug into • Define XML description in plugin.xml • Define abstract class • Programmatic loading of the extensions Extension: concrete service Implementations of abstract class defined in extension point plug-in One extension point may have 0, 1 or unlimited extensions • Code is nicely decoupled and “packaged”

  3. BOY widget extension point Example opibuilder.widgets.symbol Symbol widgets implemented by ITER opibuilder.widget … Other widgets … Slider widget Rectangle widget opibuilder widget extension point Extension usually is optional, if you don’t have that extension, you just don’t have that function.

  4. Product, Features, Plugins

  5. From Product to Plugin • org.cstudio.basic.epics.product/CSS.product • Based on “Features” • org.csstudio.sns.feature.applications • org.csstudio.diag.probe • org.csstudio.diag.epics.pvtree • … • and features …opibuilder, …databrowser Features: • “Group” plugins to better organize them • Features can be installed & updated from update sites • Individual plugins can’t

  6. Smaller Products without Features • org.csstudio.archive.engine/ArchiveEngine.product • org.csstudio.archive.config.rdb/ArchiveConfigTool.product • org.csstudio.alarm.beast.server/AlarmServer.product • org.csstudio.alarm.beast.configtool/AlarmConfigTool.produc It’s OK to not use features Easier to start that way. But: Less organized, no install, update possible.

  7. Dependencies • org.csstudio.diag.probe • MANIFEST.MF, plugin.xml • Dependency on ..utility.pv • org.csstudio.utility.pv Products that include probe must also include utility.pv.Otherwise obvious error about missing dependency at startup, or no product at all. Similar: Databrowser depends on org.csstudio.archive.reader,org.csstudio.logbook * utility.pv will be replaced by PV Manager in next release

  8. Extension Points • There are many! • Read Eclipse RCP Books • See Eclipse IDE online help • http://cs-studio.sourceforge.net/docbook/ • Study CSS Sources • For example: • Process Variable Menu • Provide Process Variable or Provide Menu • Logbook • PV Manager Data Source • Authentication & Authorization Provider • BOY Widgets

  9. To build a custom product: • You pick what you want • Probe, Data Browser, BOY, … • Add dependencies, Eclipse helps • Logbook, pv, archive, … • Determine what you may also need • pv.epics, logbook.mysite, archive.reader.* • Test within Eclipse IDE (Run Configurations…) • Then update your *product, *feature Read http://cs-studio.sourceforge.net/docbook/

More Related