/* -*- tab-width: 4 -*-
*
* Electric(tm) VLSI Design System
*
* File: ToolSettings.java
*
* Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
*
* Electric(tm) is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* Electric(tm) is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Electric(tm); see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, Mass 02111-1307, USA.
*/
package com.sun.electric.tool;
import com.sun.electric.StartupPrefs;
import com.sun.electric.database.text.Setting;
class AbstractToolSettings {
final boolean attach;
final Setting.RootGroup rootSettingGroup;
AbstractToolSettings(Setting.RootGroup rootSettingGroup) {
attach = rootSettingGroup != null;
this.rootSettingGroup = attach ? rootSettingGroup : new Setting.RootGroup();
}
}
/**
*
*/
public class ToolSettings extends AbstractToolSettings {
/**
* Returns project preference Group of a tool.
* @param groupName name of a Setting Group
* @return project preference Group of a tool.
*/
public static Setting.Group getToolSettings(String groupName) {
return t.rootSettingGroup.node(groupName);
}
/**
* Returns project preference to tell default technique in Tech Palette.
* @return project preference to tell default technique in Tech Palette.
*/
public static Setting getDefaultTechnologySetting() { return t.cacheDefaultTechnology; }
/**
* Returns project preference to tell the layout Technology to use when schematics are found.
* This is important in Spice deck generation (for example) because the Spice primitives may
* say "2x3" on them, but a real technology (such as "mocmos") must be found to convert these pure
* numbers to real spacings for the deck.
* @return project preference to tell the Technology to use when schematics are found.
*/
public static Setting getSchematicTechnologySetting() { return t.cacheSchematicTechnology; }
/**
* Returns project preference to tell whether to include the date and Electric version in output files.
* @return project preference to tell whether to include the date and Electric version in output files.
*/
public static Setting getIncludeDateAndVersionInOutputSetting() { return t.cacheIncludeDateAndVersionInOutput; }
/**
* Method to tell whether the process is a PSubstrate process. If true, it will ignore the pwell spacing rule.
* The default is "true".
* @return true if the process is PSubstrate
*/
public static Setting getPSubstrateProcessLayoutTechnologySetting() {return t.cachePSubstrateProcess;}
/**
* Returns project preference with additional technologies.
* @return project preference with additional technologies.
*/
public static Setting getSoftTechnologiesSetting() { return t.cacheSoftTechnologies; }
/**
* Returns project preference to tell whether resistors are ignored in the circuit.
* When ignored, they appear as a "short", connecting the two sides.
* When included, they appear as a component with different networks on either side.
* Returns project preference to tell whether resistors are ignored in the circuit.
*/
public static Setting getIgnoreResistorsSetting() { return t.cacheIgnoreResistors; }
/**
* Returns project preference to tell whether to add the copyright message to output decks.
* @return project preference to tell whether to add the copyright message to output decks.
*/
public static Setting getUseCopyrightMessageSetting() { return t.cacheUseCopyrightMessage; }
/**
* Returns project preference to tell the copyright message that will be added to output decks.
* @return project preference to tell the copyright message that will be added to output decks.
*/
public static Setting getCopyrightMessageSetting() { return t.cacheCopyrightMessage; }
/**
* Returns Setting to tell whether CIF Output mimics the display.
* To mimic the display, unexpanded cell instances are described as black boxes,
* instead of calls to their contents.
* @return Setting to tell whether CIF Output mimics the display.
*/
public static Setting getCIFOutMimicsDisplaySetting() { return t.cacheCIFMimicsDisplay; }
/**
* Returns Setting to tell whether CIF Output merges boxes into complex polygons.
* This takes more time but produces a smaller output file.
* @return Setting to tell whether CIF Output merges boxes into complex polygons.
*/
public static Setting getCIFOutMergesBoxesSetting() { return t.cacheCIFMergesBoxes; }
/**
* Returns Setting to tell whether CIF Output merges boxes into complex polygons.
* When this happens, a CIF "call" to the top cell is emitted.
* @return Setting to tell whether CIF Output merges boxes into complex polygons.
*/
public static Setting getCIFOutInstantiatesTopLevelSetting() { return t.cacheCIFInstantiatesTopLevel; }
/**
* Returns Setting to tell the scale factor to use for CIF Output.
* The scale factor is used in cell headers to avoid precision errors.
* @return Setting to tell the scale factor to use for CIF Output.
*/
public static Setting getCIFOutScaleFactor() { return t.cacheCIFOutScaleFactor; }
/**
* Returns Setting to tell whether GDS Output merges boxes into complex polygons.
* This takes more time but produces a smaller output file.
* @return Setting to tell if GDS Output merges boxes into complex polygons.
*/
public static Setting getGDSOutMergesBoxesSetting() { return t.cacheGDSMergesBoxes; }
/**
* Returns Setting to tell whether GDS Output writes pins at Export locations.
* Some systems can use this information to reconstruct export locations.
* @return Setting to tell whether GDS Output writes pins at Export locations.
*/
public static Setting getGDSOutWritesExportPinsSetting() { return t.cacheGDSWritesExportPins; }
/**
* Returns Setting to tell whether GDS Output makes all text upper-case.
* Some systems insist on this.
* @return Setting to tell whether GDS Output makes all text upper-case.
*/
public static Setting getGDSOutUpperCaseSetting() { return t.cacheGDSOutputUpperCase; }
/**
* Returns Setting to tell the default GDS layer to use for the text of Export pins.
* Export pins are annotated with text objects on this layer.
* If this is negative, do not write Export pins.
* @return Setting to tell to set the default GDS layer to use for the text of Export pins.
*/
public static Setting getGDSOutDefaultTextLayerSetting() { return t.cacheGDSDefaultTextLayer; }
/**
* Returns Setting to tell the state of whether the GDS writer converts brackets
* to underscores in export names.
* @return Setting to tell the state of whether the GDS writer converts brackets
*/
public static Setting getGDSOutputConvertsBracketsInExportsSetting() { return t.cacheGDSOutputConvertsBracketsInExports; }
/**
* Returns Setting to tell the maximum length (number of chars) for Cell names in the GDS output file
* @return Setting to tell the maximum length (number of chars) for Cell names in the GDS output file
*/
public static Setting getGDSCellNameLenMaxSetting() { return t.cacheGDSCellNameLenMax; }
/**
* Method to set the scale to be applied when reading GDS.
* @return the scale to be applied when reading GDS.
*/
public static Setting getGDSInputScaleSetting() { return t.cacheGDSInputScale; }
/**
* Method to set the scale to be applied when writing GDS.
* @return the scale to be applied when writing GDS.
*/
public static Setting getGDSOutputScaleSetting() { return t.cacheGDSOutputScale; }
/**
* Returns project preference to tell the DXF scale.
* The DXF scale is:
* <UL>
* <LI>-3: GigaMeters
* <LI>-2: MegaMeters
* <LI>-1: KiloMeters
* <LI>0: Meters
* <LI>1: MilliMeters
* <LI>2: MicroMeters
* <LI>3: NanoMeters
* <LI>4: PicoMeters
* <LI>5: FemtoMeters
* </UL>
* @return project preference to tell the DXF scale.
*/
public static Setting getDXFScaleSetting() { return t.cacheDXFScale; }
/**
* Returns project preference to tell whether to use local settings for Logical Effort
* @return project preference to tell whether to use local settings for Logical Effort
*/
public static Setting getUseLocalSettingsSetting() { return t.cacheUseLocalSettings; }
/**
* Returns project preference to tell the Global Fanout for Logical Effort.
* @return project preference to tell the Global Fanout for Logical Effort.
*/
public static Setting getGlobalFanoutSetting() { return t.cacheGlobalFanout; }
/**
* Returns project preference to tell the Convergence Epsilon value for Logical Effort.
* @return project preference to tell the Convergence Epsilon value for Logical Effort.
*/
public static Setting getConvergenceEpsilonSetting() { return t.cacheConvergenceEpsilon; }
/**
* Returns project preference to tell the maximum number of iterations for Logical Effort.
* @return project preference to tell the maximum number of iterations for Logical Effort.
*/
public static Setting getMaxIterationsSetting() { return t.cacheMaxIterations; }
/**
* Returns project preference to tell the keeper size ratio for Logical Effort.
* @return project preference to tell the keeper size ratio for Logical Effort.
*/
public static Setting getKeeperRatioSetting() { return t.cacheKeeperRatio; }
/**
* Returns project preferece to tell the width of the nmos of a X=1 inverter for Logical Effort.
* @return project preferece to tell the width of the nmos of a X=1 inverter for Logical Effort.
*/
public static Setting getX1InverterNWidthSetting() { return t.cacheX1InverterNWidth; }
/**
* Returns project preferece to tell the width of the pmos of a X=1 inverter for Logical Effort.
* @return project preferece to tell the width of the pmos of a X=1 inverter for Logical Effort.
*/
public static Setting getX1InverterPWidthSetting() { return t.cacheX1InverterPWidth; }
/**
* Returns project preference to tell the length of the pmos and nmos of a X=1 inverter for Logical Effort.
* @return project preference to tell the length of the pmos and nmos of a X=1 inverter for Logical Effort.
*/
public static Setting getX1InverterLengthSetting() { return t.cacheX1InverterLength; }
/**
* Returns setting to tell whether Verilog deck generation should use the Assign statement.
* @return setting to tell whether Verilog deck generation should use the Assign statement.
*/
public static Setting getVerilogUseAssignSetting() { return t.cacheVerilogUseAssign; }
/**
* Returns setting to tell whether Verilog deck generation should use Trireg by default.
* The alternative is to use the "wire" statement.
* @return setting to tell whether Verilog deck generation should use Trireg by default.
*/
public static Setting getVerilogUseTriregSetting() { return t.cacheVerilogUseTrireg; }
public static Setting getFoundrySetting() { return t.cachefoundry; }
public static Setting getEnableNCCSetting() {return t.cacheenableNCC;}
public static Setting getSizeQuantizationErrorSetting() { return t.cachequantError; }
public static Setting getMaxMosWidthSetting() {return t.cachemaxmos;}
public static Setting getVddYSetting() {return t.cachevddy;}
public static Setting getGndYSetting() {return t.cachegndy;}
public static Setting getNmosWellHeightSetting() {return t.cachenheight;}
public static Setting getPmosWellHeightSetting() {return t.cachepheight;}
public static Setting getSimpleNameSetting() {return t.cachesimpleName;}
public static Setting getGlobalSDCCommandsMAXSetting() { return t.cacheGlobalSDCCommandsMAX; }
public static Setting getGlobalSDCCommandsMINSetting() { return t.cacheGlobalSDCCommandsMIN; }
public static Setting getNumWorstPathsSetting() { return t.cacheNumWorstPaths; }
public static void attachToGroup(Setting.RootGroup rootSettingGroup) {
t = new ToolSettings(rootSettingGroup);
}
private static ToolSettings t = new ToolSettings(null);
private Setting.Group curXmlGroup;
private String curPrefGroup;
{ tool("userTool", "tool/user"); }
private final Setting cacheDefaultTechnology = makeStringSetting("DefaultTechnology", "Technology tab", "Default Technology for editing", "mocmos");
private final Setting cacheSchematicTechnology = makeStringSetting("SchematicTechnology", "Technology tab", "Schematics use scale values from this technology", "mocmos");
private final Setting cacheIncludeDateAndVersionInOutput = makeBooleanSetting("IncludeDateAndVersionInOutput", "Netlists tab", "Include date and version in output", true);
private final Setting cachePSubstrateProcess = makeBooleanSetting("PSubstrateProcess", "Technology tab", "Define Layout Technology as a PSubstrate process", true);
private final Setting cacheSoftTechnologies = makeStringSetting(StartupPrefs.SoftTechnologiesKey, "Technology tab", "A list of added Xml Technologies", StartupPrefs.SoftTechnologiesDef);
{ tool("networkTool", "database/network"); }
private final Setting cacheIgnoreResistors = makeBooleanSetting("IgnoreResistors", "Netlists tab", "Networks ignore Resistors", false);
{ tool("compactionTool", "tool/compaction"); }
{ tool("drcTool", "tool/drc"); }
{ tool("ercTool", "tool/erc"); }
{ tool("extractTool", "tool/extract"); }
{ tool("ioTool", "tool/io"); }
private final Setting cacheUseCopyrightMessage = makeBooleanSetting("UseCopyrightMessage", "Netlists tab", "Use copyright message", false);
private final Setting cacheCopyrightMessage = makeStringSetting("CopyrightMessage", "Netlists tab", "Copyright message", "");
private final Setting cacheCIFMimicsDisplay = makeBooleanSetting("CIFMimicsDisplay", "CIF tab", "CIF output mimics display", false);
private final Setting cacheCIFMergesBoxes = makeBooleanSetting("CIFMergesBoxes", "CIF tab", "CIF output merges boxes", false);
private final Setting cacheCIFInstantiatesTopLevel = makeBooleanSetting("CIFInstantiatesTopLevel", "CIF tab", "CIF output instantiates top level", true);
private final Setting cacheCIFOutScaleFactor = makeIntSetting("CIFOutScaleFactor", "CIF tab", "CIF output scale factor", 1);
private final Setting cacheGDSMergesBoxes = makeBooleanSetting("GDSMergesBoxes", "GDS tab", "GDS output merges boxes", false);
private final Setting cacheGDSWritesExportPins = makeBooleanSetting("GDSWritesExportPins", "GDS tab", "GDS output writes export pins", false);
private final Setting cacheGDSOutputUpperCase = makeBooleanSetting("GDSOutputUpperCase", "GDS tab", "GDS output all upper-case", false);
private final Setting cacheGDSDefaultTextLayer = makeIntSetting("GDSDefaultTextLayer", "GDS tab", "GDS output default text layer", 230);
private final Setting cacheGDSOutputConvertsBracketsInExports = makeBooleanSetting("GDSOutputConvertsBracketsInExports", "GDS tab", "GDS output converts brackets in exports", true);
private final Setting cacheGDSCellNameLenMax = makeIntSetting("GDSCellNameLenMax", "GDS tab", "GDS name length limit", 32);
private final Setting cacheGDSInputScale = makeDoubleSetting("GDSInputScale", "GDS tab", "GDS input scale", 1.0);
private final Setting cacheGDSOutputScale = makeDoubleSetting("GDSOutputScale", "GDS tab", "GDS output scale", 1.0);
private final Setting cacheDXFScale = makeIntSetting("DXFScale", "DXF tab", "DXF scale factor", 2);
{ tool("logeffortTool", "tool/logicaleffort"); }
private static final double DEFAULT_GLOBALFANOUT = 4.7;
private static final double DEFAULT_EPSILON = 0.001;
private static final int DEFAULT_MAXITER = 30;
private static final double DEFAULT_KEEPERRATIO = 0.1;
private static final double DEFAULT_X1INVERTER_NWIDTH = 3.0;
private static final double DEFAULT_X1INVERTER_PWIDTH = 6.0;
private static final double DEFAULT_X1INVERTER_LENGTH = 2.0;
private final Setting cacheUseLocalSettings = makeBooleanSetting("UseLocalSettings", "Logical Effort Tab", "Use Local Settings from Cell", true);
private final Setting cacheGlobalFanout = makeDoubleSetting("GlobalFanout", "Logical Effort Tab", "Global Fanout", DEFAULT_GLOBALFANOUT);
private final Setting cacheConvergenceEpsilon = makeDoubleSetting("ConvergenceEpsilon", "Logical Effort Tab", "Convergence Epsilon", DEFAULT_EPSILON);
private final Setting cacheMaxIterations = makeIntSetting("MaxIterations", "Logical Effort Tab", "Maximum Iterations", DEFAULT_MAXITER);
private final Setting cacheKeeperRatio = makeDoubleSetting("KeeperRatio", "Logical Effort Tab", "Keeper Ratio", DEFAULT_KEEPERRATIO);
private final Setting cacheX1InverterNWidth = makeDoubleSetting("X1InverterNWidth", "Logical Effort Tab", "X=1 Inverter N Width", DEFAULT_X1INVERTER_NWIDTH);
private final Setting cacheX1InverterPWidth = makeDoubleSetting("X1InverterPWidth", "Logical Effort Tab", "X=1 Inverter P Width", DEFAULT_X1INVERTER_PWIDTH);
private final Setting cacheX1InverterLength = makeDoubleSetting("X1InverterLength", "Logical Effort Tab", "X=1 Inverter Lengths", DEFAULT_X1INVERTER_LENGTH);
{ tool("parasiticTool", "tool/extract"); }
{ tool("placementTool", "tool/placement"); }
{ tool("projectTool", "tool/project"); }
{ tool("routingTool", "tool/routing"); }
{ tool("scTool", "tool/sc"); }
{ tool("simulationTool", "tool/simulation"); }
private final Setting cacheVerilogUseAssign = makeBooleanSetting("VerilogUseAssign", "Verilog tab", "Verilog uses Assign construct", false);
private final Setting cacheVerilogUseTrireg = makeBooleanSetting("VerilogUseTrireg", "Verilog tab", "Verilog presumes wire is Trireg", false);
{ tool("coverageTool", "tool/extract"); }
{ tool("GateLayoutGenerator", "tool/generator/layout"); }
private final Setting cachefoundry = makeStringSetting ("foundry", "Gate Layout Generator Tab", "Foundry", "MOCMOS");
private final Setting cacheenableNCC = makeStringSetting ("enableNCC", "Gate Layout Generator Tab", "Enable NCC checking of layout", "purpleFour");
private final Setting cachequantError = makeIntSetting ("quantError", "Gate Layout Generator Tab", "Allowable quantization error", 0);
private final Setting cachemaxmos = makeIntSetting ("maxmos", "Gate Layout Generator Tab", "Maximum width of MOS transistors", 1000);
private final Setting cachevddy = makeIntSetting ("vddy", "Gate Layout Generator Tab", "Y coordinate of VDD bus", 21);
private final Setting cachegndy = makeIntSetting ("gndy", "Gate Layout Generator Tab", "Y coordinate of GND bus", -21);
private final Setting cachenheight = makeIntSetting ("nheight", "Gate Layout Generator Tab", "Height of Nwell", 84);
private final Setting cachepheight = makeIntSetting ("pheight", "Gate Layout Generator Tab", "Height of Pwell", 84);
private final Setting cachesimpleName = makeBooleanSetting("simpleName", "Gate Layout Generator Tab", "Name is gate type plus size", true);
{ tool("Fill GeneratorTool", "tool/generator/layout/fill"); }
{ tool("CVSTool", "tool/cvspm"); }
{ tool("STATool", "plugins/sctiming"); }
private final Setting cacheGlobalSDCCommandsMAX = makeStringSetting("GlobalSDCCommands", "Static Timing Analysis Tab", "Global SDC Constraints (MAX)", "");
private final Setting cacheGlobalSDCCommandsMIN = makeStringSetting("GlobalSDCCommandsMIN", "Static Timing Analysis Tab", "Global SDC Constraints (MIN)", "");
private final Setting cacheNumWorstPaths = makeIntSetting("NumWorstPaths", "Static Timing Analysis Tab", "Num Worst Paths", 10);
private ToolSettings(Setting.RootGroup rootSettingGroup) {
super(rootSettingGroup);
curXmlGroup = null;
curPrefGroup = null;
this.rootSettingGroup.lock();
}
private void tool(String xmlPath, String prefPath) {
curXmlGroup = rootSettingGroup.node(xmlPath);
curPrefGroup = prefPath;
}
/**
* Factory methods to create a boolean project preference objects.
* The created object is stored into a field of this Tool whose name is "cache"+name.
* @param name the name of this Pref.
* @param location the user-command that can affect this meaning option.
* @param description the description of this meaning option.
* @param factory the "factory" default value (if nothing is stored).
*/
private Setting makeBooleanSetting(String name, String location, String description, boolean factory) {
if (attach)
return findSetting(name, location, description, Boolean.valueOf(factory));
return curXmlGroup.makeBooleanSetting(name, curPrefGroup, name, location, description, factory);
}
/**
* Factory methods to create an integer project preference objects.
* The created object is stored into a field of this Tool whose name is "cache"+name.
* @param name the name of this Pref.
* @param location the user-command that can affect this meaning option.
* @param description the description of this meaning option.
* @param factory the "factory" default value (if nothing is stored).
*/
private Setting makeIntSetting(String name, String location, String description, int factory) {
if (attach)
return findSetting(name, location, description, Integer.valueOf(factory));
return curXmlGroup.makeIntSetting(name, curPrefGroup, name, location, description, factory);
}
/**
* Factory methods to create a long project preference objects.
* The created object is stored into a field of this Tool whose name is "cache"+name.
* @param name the name of this Pref.
* @param location the user-command that can affect this meaning option.
* @param description the description of this meaning option.
* @param factory the "factory" default value (if nothing is stored).
*/
private Setting makeLongSetting(String name, String location, String description, long factory) {
if (attach)
return findSetting(name, location, description, Long.valueOf(factory));
return curXmlGroup.makeLongSetting(name, curPrefGroup, name, location, description, factory);
}
/**
* Factory methods to create a double project preference objects.
* The created object is stored into a field of this Tool whose name is "cache"+name.
* @param name the name of this Pref.
* @param location the user-command that can affect this meaning option.
* @param description the description of this meaning option.
* @param factory the "factory" default value (if nothing is stored).
*/
private Setting makeDoubleSetting(String name, String location, String description, double factory) {
if (attach)
return findSetting(name, location, description, Double.valueOf(factory));
return curXmlGroup.makeDoubleSetting(name, curPrefGroup, name, location, description, factory);
}
/**
* Factory methods to create a string project preference objects.
* The created object is stored into a field of this Tool whose name is "cache"+name.
* @param name the name of this Pref.
* @param location the user-command that can affect this meaning option.
* @param description the description of this meaning option.
* @param factory the "factory" default value (if nothing is stored).
*/
private Setting makeStringSetting(String name, String location, String description, String factory) {
if (attach)
return findSetting(name, location, description, factory);
return curXmlGroup.makeStringSetting(name, curPrefGroup, name, location, description, factory);
}
private Setting findSetting(String name, String location, String description, Object factory) {
Setting setting = curXmlGroup.getSetting(name);
assert setting.getPrefPath().equals(curPrefGroup + "/" + name);
assert setting.getLocation().equals(location);
assert setting.getDescription().equals(description);
assert setting.getFactoryValue().equals(factory);
return setting;
}
}