diff --git a/doc/xschem_man/developer_info.html b/doc/xschem_man/developer_info.html index bab47f20..b9efcb9d 100644 --- a/doc/xschem_man/developer_info.html +++ b/doc/xschem_man/developer_info.html @@ -481,122 +481,122 @@ C {verilog_timescale.sym} 1050 -100 0 0 {name=s1 timestep="1ns" precision="1ns" -
- Resets UI state, unselect all and abort any pending operation-
- Start a GUI placement of a symbol pin-
- Start a GUI placement of a graph object-
- Ask user to choose a png file and start a GUI placement of the image-
- Align currently selected objects to current snap setting-
- Annotate operating point data into current schematic. - use <schematic name>.raw or use supplied argument as raw file to open - look for operating point data and annotate voltages/currents into schematic-
- Start a GUI placement of an arc. - User should click 3 unaligned points to define the arc-
- Attach net labels to selected component(s) instance(s)-
- Start/end bounding box calculation: parameter is either 'begin' or 'end'-
- Break wires at selected instance pins-
- Rebuild color palette using values of tcl vars dim_value and dim_bg-
- Invoke the callback event dispatcher with a software event-
- Set case insensitive symbol lookup. Use only on case insensitive filesystems-
- List all used symbols in current schematic and warn if some symbol is newer-
- Check if all instances have a unique refdes (name attribute in xschem), - highlight such instances. If second parameter is '1' rename duplicates-
- Start a GUI placement of a circle. - User should click 3 unaligned points to define the circle-
- Clear current schematic window. Resets hierarchy level. Remove symbols - the 'force' parameter will not ask to save existing modified schematic. - the 'schematic' or 'symbol' parameter specifies to default to a schematic - or symbol window (default: schematic)-
- Clears drawing but does not purge symbols-
- Dim colors or brite colors depending on value parameter: -5 <= value <= 5-
- Compare currently loaded schematic with another 'sch_file' schematic. - if no file is given prompt user to choose one-
- Select nets connected to currently selected net or net label/pin. - if '1' argument is given, stop at wire junctions-
- Copy selection to clipboard-
- Start a GUI copy operation-
- Debug command-
- Create an xplot file in netlist/simulation directory with - the list of highlighted nodes in a format the selected waveform - viewer understands (bespice, gaw, ngspice)-
- Cut selection to clipboard-
- Set xschem in debug mode.'n' is the debug level - (0=no debug). Higher levels yield more debug info.-
- Delete selection-
- Bring up a file selector the user can use to delete files-
- Descend into selected component instance. Optional number 'n' specifies the - instance number to descend into for vector instances (default: 0).-
- Descend into the symbol view of selected component instance-
- Print a list of highlighted objects (nets, net labels/pins, instances)-
- Redraw graph rectangle number 'n'. - If the optional 'flags' integer is given it will be used as the - flags bitmask to use while drawing (can be used to restrict what to redraw)-
- Edit xschem file of current schematic if nothing is selected. - Edit .sym file if a component is selected.-
- Edit global schematic/symbol attributes or attributes - of currently selected instances-
- Edit global schematic/symbol attributes or - attributes of currently selected instances - using a text editor (defined in tcl 'editor' variable)-
- Embed base 64 encoded 'raw_file' into currently - selected element as a 'spice_data' - attribute.-
- Enable/disable layers depending on tcl array variable enable_layer()-
- Exit the program, ask for confirm if current file modified.-
- Expand vectored labels/instance names:
- xschem expandlabel {2*A[3:0]} --> A[3],A[2],A[1],A[0],A[3],A[2],A[1],A[0] 8
- last field is the number of bits
- since [ and ] are TCL special characters argument must be quoted with { and }
-
- Find n-th field string separated by characters in sep. 1st field is in position 1
- xschem find_nth {aaa,bbb,ccc,ddd} {,} 2 --> bbb
- - Flip selection horizontally-
- Flip selection horizontally, each object around its center-
- Toggle fullscreen modes: fullscreen with menu & status, fullscreen, normal-
- Get C variable/constant 'var'+
+ Resets UI state, unselect all and abort any pending operation+
+ Start a GUI placement of a symbol pin+
+ Start a GUI placement of a graph object+
+ Ask user to choose a png file and start a GUI placement of the image+
+ Align currently selected objects to current snap setting+
+ Annotate operating point data into current schematic. + use <schematic name>.raw or use supplied argument as raw file to open + look for operating point data and annotate voltages/currents into schematic+
+ Start a GUI placement of an arc. + User should click 3 unaligned points to define the arc+
+ Attach net labels to selected component(s) instance(s)+
+ Start/end bounding box calculation: parameter is either 'begin' or 'end'+
+ Break wires at selected instance pins+
+ Rebuild color palette using values of tcl vars dim_value and dim_bg+
+ Invoke the callback event dispatcher with a software event+
+ Set case insensitive symbol lookup. Use only on case insensitive filesystems+
+ List all used symbols in current schematic and warn if some symbol is newer+
+ Check if all instances have a unique refdes (name attribute in xschem), + highlight such instances. If second parameter is '1' rename duplicates+
+ Start a GUI placement of a circle. + User should click 3 unaligned points to define the circle+
+ Clear current schematic window. Resets hierarchy level. Remove symbols + the 'force' parameter will not ask to save existing modified schematic. + the 'schematic' or 'symbol' parameter specifies to default to a schematic + or symbol window (default: schematic)+
+ Clears drawing but does not purge symbols+
+ Dim colors or brite colors depending on value parameter: -5 <= value <= 5+
+ Compare currently loaded schematic with another 'sch_file' schematic. + if no file is given prompt user to choose one+
+ Select nets connected to currently selected net or net label/pin. + if '1' argument is given, stop at wire junctions+
+ Copy selection to clipboard+
+ Start a GUI copy operation+
+ Debug command+
+ Create an xplot file in netlist/simulation directory with + the list of highlighted nodes in a format the selected waveform + viewer understands (bespice, gaw, ngspice)+
+ Cut selection to clipboard+
+ Set xschem in debug mode.'n' is the debug level + (0=no debug). Higher levels yield more debug info.+
+ Delete selection+
+ Bring up a file selector the user can use to delete files+
+ Descend into selected component instance. Optional number 'n' specifies the + instance number to descend into for vector instances (default: 0).+
+ Descend into the symbol view of selected component instance+
+ Print a list of highlighted objects (nets, net labels/pins, instances)+
+ Redraw graph rectangle number 'n'. + If the optional 'flags' integer is given it will be used as the + flags bitmask to use while drawing (can be used to restrict what to redraw)+
+ Edit xschem file of current schematic if nothing is selected. + Edit .sym file if a component is selected.+
+ Edit global schematic/symbol attributes or attributes + of currently selected instances+
+ Edit global schematic/symbol attributes or + attributes of currently selected instances + using a text editor (defined in tcl 'editor' variable)+
+ Embed base 64 encoded 'raw_file' into currently + selected element as a 'spice_data' + attribute.+
+ Enable/disable layers depending on tcl array variable enable_layer()+
+ Exit the program, ask for confirm if current file modified.+
+ Expand vectored labels/instance names:
+ xschem expandlabel {2*A[3:0]} --> A[3],A[2],A[1],A[0],A[3],A[2],A[1],A[0] 8
+ last field is the number of bits
+ since [ and ] are TCL special characters argument must be quoted with { and }
+
+ Find n-th field string separated by characters in sep. 1st field is in position 1
+ xschem find_nth {aaa,bbb,ccc,ddd} {,} 2 --> bbb
+ + Flip selection horizontally+
+ Flip selection horizontally, each object around its center+
+ Toggle fullscreen modes: fullscreen with menu & status, fullscreen, normal+
+ Get C variable/constant 'var'
- Get the full attribute string of 'inst'
-
- getprop instance inst attr
- Get the value of attribute 'attr'
- If 'attr has the form 'cell::sym_attr' look up attribute 'sym_attr'
- of the symbol referenced by the instance.
-
- getprop instance_pin inst pin
- Get the full attribute string of pin 'pin' of instance 'inst'
- Example: xschem getprop instance_pin x3 MINUS --> name=MINUS dir=in
-
- getprop instance_pin inst pin pin_attr
- Get attribute 'pin_attr' of pin 'pin' of instance 'inst'
- Example: xschem getprop instance_pin x3 MINUS dir --> in
-
- getprop symbol sym_name
- Get full attribute string of symbol 'sym_name'
- example:
- xschem getprop symbol comp_ngspice.sym -->
- type=subcircuit
- format="@name @pinlist @symname
- OFFSET=@OFFSET AMPLITUDE=@AMPLITUDE GAIN=@GAIN ROUT=@ROUT COUT=@COUT"
- template="name=x1 OFFSET=0 AMPLITUDE=5 GAIN=100 ROUT=1000 COUT=1p"
-
- getprop symbol sym_name sym_attr [with_quotes]
- Get value of attribute 'sym_attr' of symbol 'sym_name'
- 'with_quotes' (default:0) is an integer passed to get_tok_value()
- getprop rect layer num attr
- Get attribute 'attr' of rectangle number 'num' on layer 'layer'
-
- getprop text num attr
- Get attribute 'attr' of text number 'num'
-
- ('inst' can be an instance name or instance number)
- ('pin' can be a pin name or pin number)
- - get value of token 'tok' in string 'str' - 'with_quotes' (default:0) is an integer passed to get_tok_value()-
- Get length of last looked up attribute name (not its value) - if returned value is 0 it means that last searched attribute did not exist-
- Return various global variables used in the program-
- Go up one level (pop) in hierarchy-
- Do a simple hash of 'file' - 'skip_path_lines' is an integer (default: 0) passed to hash_file()-
- Do a simple hashing of string 'str'-
+
+ Get the full attribute string of 'inst'
+
+ getprop instance inst attr
+ Get the value of attribute 'attr'
+ If 'attr has the form 'cell::sym_attr' look up attribute 'sym_attr'
+ of the symbol referenced by the instance.
+
+ getprop instance_pin inst pin
+ Get the full attribute string of pin 'pin' of instance 'inst'
+ Example: xschem getprop instance_pin x3 MINUS --> name=MINUS dir=in
+
+ getprop instance_pin inst pin pin_attr
+ Get attribute 'pin_attr' of pin 'pin' of instance 'inst'
+ Example: xschem getprop instance_pin x3 MINUS dir --> in
+
+ getprop symbol sym_name
+ Get full attribute string of symbol 'sym_name'
+ example:
+ xschem getprop symbol comp_ngspice.sym -->
+ type=subcircuit
+ format="@name @pinlist @symname
+ OFFSET=@OFFSET AMPLITUDE=@AMPLITUDE GAIN=@GAIN ROUT=@ROUT COUT=@COUT"
+ template="name=x1 OFFSET=0 AMPLITUDE=5 GAIN=100 ROUT=1000 COUT=1p"
+
+ getprop symbol sym_name sym_attr [with_quotes]
+ Get value of attribute 'sym_attr' of symbol 'sym_name'
+ 'with_quotes' (default:0) is an integer passed to get_tok_value()
+ getprop rect layer num attr
+ Get attribute 'attr' of rectangle number 'num' on layer 'layer'
+
+ getprop text num attr
+ Get attribute 'attr' of text number 'num'
+
+ ('inst' can be an instance name or instance number)
+ ('pin' can be a pin name or pin number)
+ + get value of token 'tok' in string 'str' + 'with_quotes' (default:0) is an integer passed to get_tok_value()+
+ Get length of last looked up attribute name (not its value) + if returned value is 0 it means that last searched attribute did not exist+
+ Return various global variables used in the program+
+ Go up one level (pop) in hierarchy+
+ Do a simple hash of 'file' + 'skip_path_lines' is an integer (default: 0) passed to hash_file()+
+ Do a simple hashing of string 'str'+
Print command help-
- Hierarchical postscript / pdf print - if 'file' is not given show a fileselector dialog box-
- Highlight selected element/pins/labels/nets - if 'drill' is given propagate net highlights through conducting elements - (elements that have the 'propag' attribute on pins )-
- Highlight instance 'inst' - 'inst' can be an instance name or number-
- Highlight net name 'net'-
- Place a new instance of symbol 'sym_name' at position x,y, - rotation and flip set to 'rot', 'flip' - if 'prop' is given it is the new instance attribute - string (default: symbol template string) - if 'first_call' is given it must be 1 on first call - and zero on following calls - It is used only for efficiency reasons if placing multiple instances-
- return instance and symbol bounding boxes - 'inst' can be an instance name or number-
- Return the name of the net attached to pin 'pin' of instance 'inst' - Example: xschem instance_net x3 MINUS --> REF-
- Return the instance name followed by a list of 'pin net' associations - example: xschem instance_nodemap x3 - --> x3 PLUS LED OUT LEVEL MINUS REF - instance x3 pin PLUS is attached to net LED, pin OUT to net LEVEL and so on...-
- Return the name and coordinates of pin with
- attribute 'attr' set to 'value' of instance 'inst'
- 'inst can be an instance name or a number
- Example: xschem instance_pin_coord x3 name MINUS --> {MINUS} 600 -840
- - Return list of pins of instance 'inst' - 'inst can be an instance name or a number-
- Get number (position) of instance name 'inst'-
- Return list of instances names and pins attached to net 'net'
- Example: xschem instances_to_net PANEL
- --> { {Vsw} {plus} {580} {-560} } { {p2} {p} {660} {-440} }
- { {Vpanel1} {minus} {600} {-440} }
- - Place a line on current layer (rectcolor) - if integer number 'pos' is given place line at indicated - position in the line array.-
- set line width to floating point number 'n'-
- List all schematics at or below current hierarchy with modification times.
- Example: xschem list_hiearchy
- -->
- 20230302_003134 {/home/.../ngspice/solar_panel.sch}
- 20230211_010031 {/home/.../ngspice/pv_ngspice.sch}
- 20221011_175308 {/home/.../ngspice/diode_ngspice.sch}
- 20221014_091945 {/home/.../ngspice/comp_ngspice.sch}
- - Sorted list of highlight nets, separated by character 'sep' (default: space)-
- List tokens in string 'str'
- with_quotes:
- 0: eat non escaped quotes (")
- 1: return unescaped quotes as part of the token value if they are present
- 2: eat backslashes
- - Load a new file 'f'. - 'force': do not ask to save modified file or warn if opening an already open file - 'noundoreset': do not reset the undo history - 'symbol': do not load symbols (used if loading a symbol instead of a schematic) - 'nofullzoom': do not do a fll zoom on new schematic.-
- Load schematic in a new tab/window. If 'f' not given prompt user-
- If 'f' is given output stderr messages to file 'f' - if 'f' is not given and a file log is open, close log - file and resume logging to stderr-
- Get logic state of net named 'net_name' - Returns 0, 1, 2, 3 for logic levels 0, 1, X, Z or nothing if no net found.-
- set 'net_name' to logic level 'n' 'num' times. - 'n': - 0 set to logic value 0 - 1 set to logic value 1 - 2 set to logic value X - 3 set to logic value Z - -1 toggle logic valie (1->0, 0->1) - the 'num' parameter is essentially useful only with 'toggle' (-1) value-
- set selected nets, net labels or pins to logic level 'n' 'num' times. - 'n': - 0 set to logic value 0 - 1 set to logic value 1 - 2 set to logic value X - 3 set to logic value Z - -1 toggle logic valie (1->0, 0->1) - the 'num' parameter is essentially useful only with 'toggle' (-1) value-
- Make a schematic from selected symbol-
- Create an LCC instance from selection and place it instead of selection - also ask if a symbol (.sym) file needs to be created-
- From current schematic (circuit.sch) create a symbol (circuit.sym) - using ipin.sym, opin.sym, iopin.sym in schematic - to deduce symbol interface pins.-
- Merge another file. if 'f' not given prompt user.-
- Start a move operation on selection and let user terminate the operation in the GUI - if dx and dy are given move by that amount.-
- Place a new net label - 'type': 1: place a 'lab_pin.sym' label - 0: place a 'lab_wire.sym' label - User should complete the placement in the GUI.-
- Highlight nets attached to selected symbols with - a different name than symbol pin-
- do a netlist of current schematic in currently defined netlist format-
- Open/destroy a new tab or window
- create: create new empty window or with 'file' loaded if 'file' given.
- The winpath must be given (even {} is ok) but not used.
- destroy: destroy tab/window identified by winpath. Example:
- xschem new_schematic destroy .x1.drw
- destroy_all: close all tabs/additional windows
- switch_win: switch context to specified 'winpath' window
- switch_tab: switch context to specified 'winpath' tab
- Main window/tab has winpath set to .drw,
- Additional windows/tabs have winpath set to .x1.drw, .x2.drw and so on...
- - Start a new xschem process for a symbol. - If 'f' is given load specified symbol.-
- Start a new xschem process for a schematic. - If 'f' is given load specified schematic.-
- dim schematic to better show highlights-
- Move origin to 'x, y', optionally changing zoom level to 'zoom'-
- debug command to test parse_cmd_string() - splits a command string into argv-like arguments - return # of args in *argc - argv[*argc] is always set to NULL-
- Debug command to test vector net syntax parser-
- Paste clipboard. If 'x y' not given user should complete placement in the GUI-
- List all pins of instance 'inst'
- Example: xschem pinlist x3
- --> { {0} {name=PLUS dir=in } } { {1} {name=OUT dir=out } }
- { {2} {name=MINUS dir=in } }
- - Start a GUI placement operation of specified 'sym_name' symbol. - If 'sym_name' not given prompt user - 'prop' is the attribute string of the symbol. - If not given take from symbol template attribute.-
- Start a GUI placement of a text object-
- Start a GUI placement of a polygon-
- Used in fileselector to show a schematic preview.-
- Export current schematic to image. - img x y size xschem area to export - 0 1 2 3 4 5 6 7 8 9 - xschem print png file.png 400 300 [ -300 -200 300 200 ] - xschem print svg file.svg 400 300 [ -300 -200 300 200 ] - xschem print ps file.ps - xschem print pdf file.pdf-
- from highlighted nets/pins/labels: - show == 0 ==> create pins from highlight nets - show == 1 ==> show list of highlight net in a dialog box - show == 2 ==> create labels with i prefix from hilight nets - show == 3 ==> show list of highlight net with path and label - expansion in a dialog box - show == 4 ==> create labels without i prefix from hilight nets - for show = 0, 2, 4 user should complete GUI placement - of created objects-
- Print spice raw netlist line for instance (number or name) 'inst'-
- Debug: wrapper to propagate_hilights() function-
- Push current state on undo stack-
- Delete loaded simulation raw file-
- xschem raw_query list: get list of saved simulation variables - xschem raw_query vars: get number of simulation variables - xschem raw_query datasets: get number of datasets (simulation runs) - xschem raw_query value node n: return n-th value of 'node' in raw file - xschem raw_query loaded: return hierarchy level - where raw file was loaded or -1 if no raw loaded - xschem raw_query index node: get index of simulation variable 'node'. - Example: raw_query index v(led) --> 46 - xschem raw_query values node [dset] : print all simulation - values of 'node' for dataset 'dset' (default dset=0) - xschem raw_query points [dset] : print simulation points for - dataset 'dset' (default dset=0)-
- If a raw file is already loaded delete from memory - else load specified file and analysis 'sim' (dc, ac, tran, op, ...) - If 'sim' not specified load first section found in raw file.-
- If a simulation raw file is already loaded delete from memory - else read section 'sim' (tran, dc, ac, op, ...) - of base64 encoded data from a 'spice_data' - attribute of selected instance - If sim not given read first section found-
- Rebuild logical connectivity abstraction of schematic-
- Rebuild selection list-
- if 'x1 y1 x2 y2'is given place recangle on current - layer (rectcolor) at indicated coordinates. - if 'pos' is given insert at given position in rectangle array. - If no coordinates are given start a GUI operation of rectangle placement-
- Redo last undone action-
- redraw window-
- Forced (be careful!) Reload current schematic from disk-
- Reload all used symbols from disk-
- Internal command: remove all symbol definitions-
- Replace 'inst' symbol with 'new_symbol' - If doing multiple substitutions set 'fast' to 0 - on first call and non zero on next calls - for faster operation - Example: xschem replace_symbol R3 capa.sym-
- Rotate selected objects around their centers-
- Save schematic if modified. Does not ask confirmation!-
- save current schematic as 'file'
- if file is empty ({}) use current schematic name
- as defalt and prompt user with file selector
- 'type' is used used to set/change file extension:
- schematic: save as schematic (*.sch)
- symbol: save as symbol (*.sym)
- If not specified default to schematic (*.sch)
- Does not ask confirmation if file name given
- - When a symbol is selected edit corresponding schematic - in a new tab/window if not already open. - If nothing selected open another window of the second - schematic (issues a warning). - if 'new_process' is given start a new xschem process-
- Search instances with attribute string containing 'tok'
- attribute and value 'val'
- search can be exact ('exact') or as a regular expression ('regex')
- select:
- 0 : highlight matching instances
- 1 : select matching instances
- -1 : unselect matching instances
- 'tok' set as:
- propstring : will search for 'val' in the entire
- *instance* attribute string.
- cell::propstring : will search for 'val' in the entire
- *symbol* attribute string.
- cell::name : will search for 'val' in the symbol name
- cell::<attr> will search for 'val' in symbol attribute 'attr'
- example: xschem search regex 0 cell::template GAIN=100
- - Select indicated instance or wire or text. - For 'instance' 'id' can be the instance name or number - for 'wire' or 'text' 'id' is the position in the respective arrays - if 'clear' is specified does an unselect operation-
- Selects all objects in schematic-
- Select all highlight objects (wires, labels, pins, instances)-
- Return a list of selected instance names-
+
+ Hierarchical postscript / pdf print + if 'file' is not given show a fileselector dialog box+
+ Highlight selected element/pins/labels/nets + if 'drill' is given propagate net highlights through conducting elements + (elements that have the 'propag' attribute on pins )+
+ Highlight instance 'inst' + 'inst' can be an instance name or number+
+ Highlight net name 'net'+
+ Place a new instance of symbol 'sym_name' at position x,y, + rotation and flip set to 'rot', 'flip' + if 'prop' is given it is the new instance attribute + string (default: symbol template string) + if 'first_call' is given it must be 1 on first call + and zero on following calls + It is used only for efficiency reasons if placing multiple instances+
+ return instance and symbol bounding boxes + 'inst' can be an instance name or number+
+ Return the name of the net attached to pin 'pin' of instance 'inst' + Example: xschem instance_net x3 MINUS --> REF+
+ Return the instance name followed by a list of 'pin net' associations + example: xschem instance_nodemap x3 + --> x3 PLUS LED OUT LEVEL MINUS REF + instance x3 pin PLUS is attached to net LED, pin OUT to net LEVEL and so on...+
+ Return the name and coordinates of pin with
+ attribute 'attr' set to 'value' of instance 'inst'
+ 'inst can be an instance name or a number
+ Example: xschem instance_pin_coord x3 name MINUS --> {MINUS} 600 -840
+ + Return list of pins of instance 'inst' + 'inst can be an instance name or a number+
+ Get number (position) of instance name 'inst'+
+ Return list of instances names and pins attached to net 'net'
+ Example: xschem instances_to_net PANEL
+ --> { {Vsw} {plus} {580} {-560} } { {p2} {p} {660} {-440} }
+ { {Vpanel1} {minus} {600} {-440} }
+ + Place a line on current layer (rectcolor) + if integer number 'pos' is given place line at indicated + position in the line array.+
+ set line width to floating point number 'n'+
+ List all schematics at or below current hierarchy with modification times.
+ Example: xschem list_hiearchy
+ -->
+ 20230302_003134 {/home/.../ngspice/solar_panel.sch}
+ 20230211_010031 {/home/.../ngspice/pv_ngspice.sch}
+ 20221011_175308 {/home/.../ngspice/diode_ngspice.sch}
+ 20221014_091945 {/home/.../ngspice/comp_ngspice.sch}
+ + Sorted list of highlight nets, separated by character 'sep' (default: space)+
+ List tokens in string 'str'
+ with_quotes:
+ 0: eat non escaped quotes (")
+ 1: return unescaped quotes as part of the token value if they are present
+ 2: eat backslashes
+ + Load a new file 'f'. + 'force': do not ask to save modified file or warn if opening an already open file + 'noundoreset': do not reset the undo history + 'symbol': do not load symbols (used if loading a symbol instead of a schematic) + 'nofullzoom': do not do a fll zoom on new schematic.+
+ Load schematic in a new tab/window. If 'f' not given prompt user+
+ If 'f' is given output stderr messages to file 'f' + if 'f' is not given and a file log is open, close log + file and resume logging to stderr+
+ Get logic state of net named 'net_name' + Returns 0, 1, 2, 3 for logic levels 0, 1, X, Z or nothing if no net found.+
+ set 'net_name' to logic level 'n' 'num' times. + 'n': + 0 set to logic value 0 + 1 set to logic value 1 + 2 set to logic value X + 3 set to logic value Z + -1 toggle logic valie (1->0, 0->1) + the 'num' parameter is essentially useful only with 'toggle' (-1) value+
+ set selected nets, net labels or pins to logic level 'n' 'num' times. + 'n': + 0 set to logic value 0 + 1 set to logic value 1 + 2 set to logic value X + 3 set to logic value Z + -1 toggle logic valie (1->0, 0->1) + the 'num' parameter is essentially useful only with 'toggle' (-1) value+
+ Make a schematic from selected symbol+
+ Create an LCC instance from selection and place it instead of selection + also ask if a symbol (.sym) file needs to be created+
+ From current schematic (circuit.sch) create a symbol (circuit.sym) + using ipin.sym, opin.sym, iopin.sym in schematic + to deduce symbol interface pins.+
+ Merge another file. if 'f' not given prompt user.+
+ Start a move operation on selection and let user terminate the operation in the GUI + if dx and dy are given move by that amount.+
+ Place a new net label + 'type': 1: place a 'lab_pin.sym' label + 0: place a 'lab_wire.sym' label + User should complete the placement in the GUI.+
+ Highlight nets attached to selected symbols with + a different name than symbol pin+
+ do a netlist of current schematic in currently defined netlist format+
+ Open/destroy a new tab or window
+ create: create new empty window or with 'file' loaded if 'file' given.
+ The winpath must be given (even {} is ok) but not used.
+ destroy: destroy tab/window identified by winpath. Example:
+ xschem new_schematic destroy .x1.drw
+ destroy_all: close all tabs/additional windows
+ switch_win: switch context to specified 'winpath' window
+ switch_tab: switch context to specified 'winpath' tab
+ Main window/tab has winpath set to .drw,
+ Additional windows/tabs have winpath set to .x1.drw, .x2.drw and so on...
+ + Start a new xschem process for a symbol. + If 'f' is given load specified symbol.+
+ Start a new xschem process for a schematic. + If 'f' is given load specified schematic.+
+ dim schematic to better show highlights+
+ Move origin to 'x, y', optionally changing zoom level to 'zoom'+
+ debug command to test parse_cmd_string() + splits a command string into argv-like arguments + return # of args in *argc + argv[*argc] is always set to NULL+
+ Debug command to test vector net syntax parser+
+ Paste clipboard. If 'x y' not given user should complete placement in the GUI+
+ List all pins of instance 'inst'
+ Example: xschem pinlist x3
+ --> { {0} {name=PLUS dir=in } } { {1} {name=OUT dir=out } }
+ { {2} {name=MINUS dir=in } }
+ + Start a GUI placement operation of specified 'sym_name' symbol. + If 'sym_name' not given prompt user + 'prop' is the attribute string of the symbol. + If not given take from symbol template attribute.+
+ Start a GUI placement of a text object+
+ Start a GUI placement of a polygon+
+ Used in fileselector to show a schematic preview.+
+ Export current schematic to image. + img x y size xschem area to export + 0 1 2 3 4 5 6 7 8 9 + xschem print png file.png 400 300 [ -300 -200 300 200 ] + xschem print svg file.svg 400 300 [ -300 -200 300 200 ] + xschem print ps file.ps + xschem print pdf file.pdf+
+ from highlighted nets/pins/labels: + show == 0 ==> create pins from highlight nets + show == 1 ==> show list of highlight net in a dialog box + show == 2 ==> create labels with i prefix from hilight nets + show == 3 ==> show list of highlight net with path and label + expansion in a dialog box + show == 4 ==> create labels without i prefix from hilight nets + for show = 0, 2, 4 user should complete GUI placement + of created objects+
+ Print spice raw netlist line for instance (number or name) 'inst'+
+ Debug: wrapper to propagate_hilights() function+
+ Push current state on undo stack+
+ Delete loaded simulation raw file+
+ xschem raw_query list: get list of saved simulation variables + xschem raw_query vars: get number of simulation variables + xschem raw_query datasets: get number of datasets (simulation runs) + xschem raw_query value node n: return n-th value of 'node' in raw file + xschem raw_query loaded: return hierarchy level + where raw file was loaded or -1 if no raw loaded + xschem raw_query index node: get index of simulation variable 'node'. + Example: raw_query index v(led) --> 46 + xschem raw_query values node [dset] : print all simulation + values of 'node' for dataset 'dset' (default dset=0) + xschem raw_query points [dset] : print simulation points for + dataset 'dset' (default dset=0)+
+ If a raw file is already loaded delete from memory + else load specified file and analysis 'sim' (dc, ac, tran, op, ...) + If 'sim' not specified load first section found in raw file.+
+ If a simulation raw file is already loaded delete from memory + else read section 'sim' (tran, dc, ac, op, ...) + of base64 encoded data from a 'spice_data' + attribute of selected instance + If sim not given read first section found+
+ Rebuild logical connectivity abstraction of schematic+
+ Rebuild selection list+
+ if 'x1 y1 x2 y2'is given place recangle on current + layer (rectcolor) at indicated coordinates. + if 'pos' is given insert at given position in rectangle array. + If no coordinates are given start a GUI operation of rectangle placement+
+ Redo last undone action+
+ redraw window+
+ Forced (be careful!) Reload current schematic from disk+
+ Reload all used symbols from disk+
+ Internal command: remove all symbol definitions+
+ Replace 'inst' symbol with 'new_symbol' + If doing multiple substitutions set 'fast' to 0 + on first call and non zero on next calls + for faster operation + Example: xschem replace_symbol R3 capa.sym+
+ Rotate selected objects around their centers+
+ Save schematic if modified. Does not ask confirmation!+
+ save current schematic as 'file'
+ if file is empty ({}) use current schematic name
+ as defalt and prompt user with file selector
+ 'type' is used used to set/change file extension:
+ schematic: save as schematic (*.sch)
+ symbol: save as symbol (*.sym)
+ If not specified default to schematic (*.sch)
+ Does not ask confirmation if file name given
+ + When a symbol is selected edit corresponding schematic + in a new tab/window if not already open. + If nothing selected open another window of the second + schematic (issues a warning). + if 'new_process' is given start a new xschem process+
+ Search instances with attribute string containing 'tok'
+ attribute and value 'val'
+ search can be exact ('exact') or as a regular expression ('regex')
+ select:
+ 0 : highlight matching instances
+ 1 : select matching instances
+ -1 : unselect matching instances
+ 'tok' set as:
+ propstring : will search for 'val' in the entire
+ *instance* attribute string.
+ cell::propstring : will search for 'val' in the entire
+ *symbol* attribute string.
+ cell::name : will search for 'val' in the symbol name
+ cell::<attr> will search for 'val' in symbol attribute 'attr'
+ example: xschem search regex 0 cell::template GAIN=100
+ + Select indicated instance or wire or text. + For 'instance' 'id' can be the instance name or number + for 'wire' or 'text' 'id' is the position in the respective arrays + if 'clear' is specified does an unselect operation+
+ Selects all objects in schematic+
+ Select all highlight objects (wires, labels, pins, instances)+
+ Return a list of selected instance names+
Return list of selected nets-
- Send selected wires/net labels/pins/voltage source or ammeter currents to current - open viewer (gaw or bespice)-
- Set C variable 'var' to 'value'+
+ Send selected wires/net labels/pins/voltage source or ammeter currents to current + open viewer (gaw or bespice)+
+ Set C variable 'var' to 'value'
- Return string 'str' replacing/adding/removing tokens that are - different between 'new_str' and 'old_str'-
- Force modify status on current schematic-
- set attribute 'tok' of instance (name or number) 'inst' to value 'val' - If 'val' not given (no attribute value) delete attribute from instance - If 'fast' argument if given does not redraw and is not undoable - setprop rect lay n tok [val] [fast|fastundo] - Set attribute 'tok' of rectangle number'n' on layer 'lay' - If 'val' not given (no attribute value) delete attribute from rect - If 'fast' argument is given does not redraw and is not undoable - If 'fastundo' s given same as above but action is undoable. - setprop rect 2 n fullxzoom - setprop rect 2 n fullyzoom - These commands do full x/y zoom of graph 'n' (on layer 2, this is hardcoded). - setprop text n tok [val] [fast|fastundo] - Set attribute 'tok' of text number 'n' - If 'val' not given (no attribute value) delete attribute from text - If 'fast' argument is given does not redraw and is not undoable - If 'fastundo' s given same as above but action is undoable.-
- Run a simulation (start simulator configured as default in - Tools -> Configure simulators and tools)-
- Start a GUI start snapped wire placement (click to start a - wire to closest pin/net endpoint)-
- Return string 'str' with 'tok' attribute value replaced with 'newval'-
- When a symbol is selected edit it in a new tab/window if not already open. - If nothing selected open another window of the second schematic (issues a warning). - if 'new_process' is given start a new xschem process-
- List all used symbols-
- If a simulation raw file is lodaded unload from memory. - else read a tabular file 'table_file' - First line is the header line containing variable names. - data is presented in column format after the header line - First column is sweep (x-axis) variable - Double empty lines start a new dataset - Single empty lines are ignored - Datasets can have different # of lines. - new dataset do not start with a header row. - Lines beginning with '#' are comments and ignored - - time var_a var_b var_c - # this is a comment, ignored - 0.0 0.0 1.8 0.3 - <single empty line: ignored> - 0.1 0.0 1.5 0.6 - ... ... ... ... - <empty line> - <Second empty line: start new dataset> - 0.0 0.0 1.8 0.3 - 0.1 0.0 1.5 0.6 - ... ... ... ...-
- testmode-
- Toggle dark/light colorscheme-
- Translate string 'str' replacing @xxx tokens with values in instance 'n' attributes-
- Remove operlapping wires, join lines, trim wires at intersections-
- Undo last action-
- Use disk file ('disk') or RAM ('memory') for undo bufer
- - Clear all highlights-
- Unhighlight selected nets/pins-
- Unselect everything-
- Update all symbol bounding boxes (useful if show_pin_net_names is set)-
- View attributes of selected element (read only) - if multiple selection show the first element (in xschem array order)-
- Highlight or select (if 'sel' set to 1) perfectly overlapped instances - this is usually an error and difficult to grasp visually-
- Used by xschem.tcl for configure events-
- Place a new wire - if no coordinates are given start a GUI wire placement-
- For debug-
- Zoom to specified coordinates, if 'factor' is given reduce view (factor < 1.0) - or add border (factor > 1.0) - If no coordinates are given start GUI zoom box operation-
- Set full view. - If 'center' is given center vire instead of lower-left align - If 'nodraw' is given don't redraw - If 'nolinewidth]' is given don't reset line widths.-
- Zoom to highlighted objects-
- Zoom in drawing-
- Zoom out drawing-
- Zoom to selection- +
+ Return string 'str' replacing/adding/removing tokens that are + different between 'new_str' and 'old_str'+
+ Force modify status on current schematic+
+ set attribute 'tok' of instance (name or number) 'inst' to value 'val' + If 'val' not given (no attribute value) delete attribute from instance + If 'fast' argument if given does not redraw and is not undoable + setprop rect lay n tok [val] [fast|fastundo] + Set attribute 'tok' of rectangle number'n' on layer 'lay' + If 'val' not given (no attribute value) delete attribute from rect + If 'fast' argument is given does not redraw and is not undoable + If 'fastundo' s given same as above but action is undoable. + setprop rect 2 n fullxzoom + setprop rect 2 n fullyzoom + These commands do full x/y zoom of graph 'n' (on layer 2, this is hardcoded). + setprop text n tok [val] [fast|fastundo] + Set attribute 'tok' of text number 'n' + If 'val' not given (no attribute value) delete attribute from text + If 'fast' argument is given does not redraw and is not undoable + If 'fastundo' s given same as above but action is undoable.+
+ Run a simulation (start simulator configured as default in + Tools -> Configure simulators and tools)+
+ Start a GUI start snapped wire placement (click to start a + wire to closest pin/net endpoint)+
+ Return string 'str' with 'tok' attribute value replaced with 'newval'+
+ When a symbol is selected edit it in a new tab/window if not already open. + If nothing selected open another window of the second schematic (issues a warning). + if 'new_process' is given start a new xschem process+
+ List all used symbols+
+ If a simulation raw file is lodaded unload from memory. + else read a tabular file 'table_file' + First line is the header line containing variable names. + data is presented in column format after the header line + First column is sweep (x-axis) variable + Double empty lines start a new dataset + Single empty lines are ignored + Datasets can have different # of lines. + new dataset do not start with a header row. + Lines beginning with '#' are comments and ignored + + time var_a var_b var_c + # this is a comment, ignored + 0.0 0.0 1.8 0.3 + <single empty line: ignored> + 0.1 0.0 1.5 0.6 + ... ... ... ... + <empty line> + <Second empty line: start new dataset> + 0.0 0.0 1.8 0.3 + 0.1 0.0 1.5 0.6 + ... ... ... ...+
+ testmode+
+ Toggle dark/light colorscheme+
+ Translate string 'str' replacing @xxx tokens with values in instance 'n' attributes+
+ Remove operlapping wires, join lines, trim wires at intersections+
+ Undo last action+
+ Use disk file ('disk') or RAM ('memory') for undo bufer
+ + Clear all highlights+
+ Unhighlight selected nets/pins+
+ Unselect everything+
+ Update all symbol bounding boxes (useful if show_pin_net_names is set)+
+ View attributes of selected element (read only) + if multiple selection show the first element (in xschem array order)+
+ Highlight or select (if 'sel' set to 1) perfectly overlapped instances + this is usually an error and difficult to grasp visually+
+ Used by xschem.tcl for configure events+
+ Place a new wire + if no coordinates are given start a GUI wire placement+
+ For debug+
+ Zoom to specified coordinates, if 'factor' is given reduce view (factor < 1.0) + or add border (factor > 1.0) + If no coordinates are given start GUI zoom box operation+
+ Set full view. + If 'center' is given center vire instead of lower-left align + If 'nodraw' is given don't redraw + If 'nolinewidth]' is given don't reset line widths.+
+ Zoom to highlighted objects+
+ Zoom in drawing+
+ Zoom out drawing+
+ Zoom to selectiondiff --git a/src/scheduler.c b/src/scheduler.c index fe480bae..c3cbf821 100644 --- a/src/scheduler.c +++ b/src/scheduler.c @@ -1216,7 +1216,7 @@ int xschem(ClientData clientdata, Tcl_Interp *interp, int argc, const char * arg /* get_tok str tok [with_quotes] * get value of token 'tok' in string 'str' - * 'with_quotes' (default:0) is an integer passed to get_tok_value() */ + * 'with_quotes' (default:0) is an integer passed to get_tok_value() */ else if(!strcmp(argv[1], "get_tok") ) { char *s=NULL; @@ -2042,7 +2042,7 @@ int xschem(ClientData clientdata, Tcl_Interp *interp, int argc, const char * arg } /* netlist - * do a netlist of current schematic in currently defined netlist format */ + * do a netlist of current schematic in currently defined netlist format */ else if(!strcmp(argv[1], "netlist") ) { yyparse_error = 0;