Bartels User Language
Programmer's Guide

PDF Version (2.1 MB; updated 11 November 2013)

Contents

Organization of this Documentation

Related Documentation

Problems, Questions, Suggestions

Documentation Notations

Documentation Conventions

Copyright

1.1

What is Bartels User Language?

1.1.1

Purpose

1.1.2

Components

1.2

Characteristics of the Bartels User Language

1.2.1

Bartels User Language Compared to C

1.2.2

Data Types, Constants, Variables

1.2.3

Operators, Assignments

1.2.4

Control Structures

1.2.5

Program Flow, Functions

1.2.6

Special In-Build Features

2.1

Introducing User Language Programming

2.1.1

The first User Language Program

2.1.2

Variables, Arithmetic and Functions

2.1.3

Arrays and Control Structures

2.2

Lexical Conventions

2.2.1

Spacing

2.2.2

Identifiers

2.2.3

Constants and Constant Expressions

2.2.4

Terminal Symbols

2.3

Data Types and Definitions

2.3.1

Data Types

2.3.2

Variables

2.3.3

Functions

2.3.4

Scope Rules

2.4

Expressions

2.4.1

Primary Expressions

2.4.2

Unary Expressions

2.4.3

Binary Expressions

2.4.4

Expression List

2.4.5

Precedence and Order of Evaluation

2.5

Control Structures

2.5.1

Concatenations

2.5.2

Alternations

2.5.3

Repetitions

2.5.4

Program Flow Control

2.6

Preprocessor Statements

2.6.1

File Inclusion

2.6.2

Constant Definition

2.6.3

Conditional Compilation

2.6.4

BNF Precompiler

2.6.5

Program Caller Type and Undo Mechanism

2.7

Syntax Definition

3.1

Conventions

3.1.1

Program Storage

3.1.2

Machine Architecture

3.2

Compiler

3.2.1

Mode of Operation

3.2.2

Compiler Call

3.2.3

Error Handling

3.3

Interpreter

3.3.1

Mode of Operation

3.3.2

Program Call

3.3.3

Error Handling

4.1

User Language Include Files

4.1.1

Standard Include Files

4.1.2

Schematic Include Files

4.1.3

Layout Include File

4.1.4

IC Design Include Files

4.2

User Language Programs

4.2.1

Standard Programs

4.2.2

Schematic Editor Programs

4.2.3

Layout Programs

4.2.4

Layout Editor Programs

4.2.5

Autorouter Programs

4.2.6

CAM Processor Programs

4.2.7

CAM View Programs

4.2.8

IC Design Programs

4.2.9

Chip Editor Programs

4.3

User Language Program Installation

4.3.1

Program Compilation

4.3.2

Menu Assignments and Key Bindings

A.1

Conventions

A.1.1

Interpreter Environment

A.1.2

Caller Type

A.2

Value Range Definitions

A.2.1

Standard Value Ranges (STD)

A.2.2

Schematic Capture Value Ranges (CAP)

A.2.3

Schematic Editor Ranges (SCM)

A.2.4

Layout Value Ranges (LAY)

A.2.5

CAM Processor Value Ranges (CAM)

A.2.6

IC Design Value Ranges (ICD)

B.1

Index Reference

B.1.1

Standard Index Variable Types (STD)

B.1.2

Schematic Capture Index Variable Types (CAP)

B.1.3

Layout Index Variable Types (LAY)

B.1.4

CAM View Index Variable Types (CV)

B.1.5

IC Design Index Variable Types (ICD)

B.2

Standard Index Description (STD)

B.3

Schematic Capture Index Description (CAP)

B.4

Layout Index Description (LAY)

B.5

CAM View Index Description (CV)

B.6

IC Design Index Description (ICD)

C.1

Function Reference

C.1.1

Standard System Functions (STD)

C.1.2

Schematic Capture System Functions (CAP)

C.1.3

Schematic Editor System Functions (SCM)

C.1.4

Layout System Functions (LAY)

C.1.5

Layout Editor System Functions (GED)

C.1.6

Autorouter System Functions (AR)

C.1.7

CAM Processor System Functions (CAM)

C.1.8

CAM View System Functions (CV)

C.1.9

IC Design System Functions (ICD)

C.1.10

Chip Editor System Functions (CED)

C.2

Standard System Functions

C.3

SCM System Functions

C.3.1

Schematic Data Access Functions

C.3.2

Schematic Editor Functions

C.4

PCB Design System Functions

C.4.1

Layout Data Access Functions

C.4.2

Layout Editor Functions

C.4.3

Autorouter Functions

C.4.4

CAM Processor Functions

C.4.5

CAM View Functions

C.5

IC Design System Functions

C.5.1

IC Design Data Access Functions

C.5.2

Chip Editor Functions

2-1

Character Escape Sequences

2-2

Reserved Words

2-3

Operators

2-4

Operator Precedence and Order of Evaluation

3-1

User Language Machine Instruction Set

3-2

Key-driven Program Call

3-3

Event-driven Program Call

A-1

User Language Caller Types

A-2

Compatibility Caller Type versus Caller Type

A-3

Compatibility Caller Type versus Interpreter

Preface

The Bartels User Language - Programmer's Guide describes how to use the Bartels User Language in Bartels AutoEngineer, i.e., how it is integrated to the Bartels AutoEngineer EDA system and how it can be applied. The following main topics are covered by this manual:

• Basic concepts and description of the Bartels User Language
• The Bartels User Language programming system:
  User Language Compiler and User Language Interpreter
• User Language example source code listings, short information on the User Language programs supplied with the Bartels AutoEngineer
• Special data types defined for accessing Bartels AutoEngineer design data
• User Language system function reference

This documentation is intended for the users of the Bartels AutoEngineer CAD software. The reader should be familiar with the use of his operating system, a text editor for generating ASCII files on his system and the Bartels AutoEngineer. Moderate experience with programming languages in general and the C programming language in particularity is recommended as well.

Those BAE users not planning to do any User Language programming should at least have a look to chapter 4 of this manual, where all User Language programs provided with the BAE software are listed with short descriptions.

Kindly note the Copyright before making use of the information provided with this documentation or applying the herein described products. The reader should also be familiar with the Notations and Conventions used throughout this documentation.

Organization of this Documentation

Related Documentation

The Bartels AutoEngineer® - Installation Guide describes the Bartels AutoEngineer configurations and system requirements and provides detailed Bartels AutoEngineer installation instructions for all supported hardware and software platforms.

The Bartels AutoEngineer® - User Manual describes in detail how to use the Bartels AutoEngineer CAE/CAD/CAM design system. The following main topics are covered by this manual:

• Introduction: System Architecture, general Operating Instructions, Design Database
• Circuit Design (CAE), Schematic Editor
• Netlist Processing, Forward and Backward Annotation
• PCB Design and manufacturing data processing (CAD/CAM), Layout Editor, Autoplacement, Autorouting, CAM Processor, CAM View
• IC/ASIC Design, Chip Editor for interactive IC mask layout, Cell Placer and Cell Router for place & route, GDS and CIF import and export
• Neural Rule System
• Utility Programs

The Bartels AutoEngineer® - Symbol and Part Libraries documentation contains detailed information about the symbol and part libraries provided with the Bartels AutoEngineer CAE/CAD/CAM design system.

Problems, Questions, Suggestions

We appreciate comments from the people who use our system. In particular we are thankful for suggestions on how to improve the Bartels AutoEngineer and/or the Bartels User Language by introducing new or improving existing functions. Please do not hesitate to contact Bartels Support if you have questions or problems related to the use of the Bartels User Language. Check the Bartels Website at http://www.bartels.de for our address.

Documentation Notations

The reader should be familiar with the following notations used throughout the Bartels AutoEngineer documentation:

The following acronyms are used throughout the Bartels AutoEngineer documentation:

Documentation Conventions

Unless otherwise mentioned, the following symbolic conventions are used throughout the Bartels AutoEngineer documentation:

Lineprint	Lineprint font represents text output generated by the system.
Boldface	Boldfaced words or characters in format or command descriptions represent topic definitions or syntactic terminals, i.e., commands or keywords to be inserted directly.
Emphasize	Emphasized text is used for optical accentuation.
" "	Double quotes denote names and/or path names or enclose characters and/or character sequences directly to be inserted.
[ ]	Square brackets enclose optional items in format or command descriptions.
{ }	Braces enclose a list of items in format or command description, from which one has to be chosen.
|	A vertical bar separates items in a list of choices.
< >	Angle brackets enclose the logical name of a key on the keyboard. In format or command descriptions, angle brackets enclose values to be supplied.
>	Boldfaced greater signs in lineprint font are used for denoting prompts on operating system level.
...	Horizontal ellipsis points indicate either optional repetition of the preceding element in format or command descriptions or absence of irrelevant parts of a figure or example.
:	Vertical ellipsis points indicate absence of irrelevant parts of a figure, an example or a format or command description.
	Any Mouse Button (MB)
	Left Mouse Button (LMB)
	Middle Mouse Button (MMB)
	Right Mouse Button (RMB)
	Keyboard (input) - Return/Enter key (CR)
a b ...	Keyboard (input) - standard key(s)
F1 F2 ...	Keyboard (input) - function key(s)
filename	File or directory path name.
keyword	Topic definitions or syntactic terminals, i.e., commands or keywords to be inserted directly.
message	BAE/system status or error message display.
Menu	Bartels AutoEngineer menu.
Menu Function	Bartels AutoEngineer menu function.
Menu Option	Bartels AutoEngineer menu option.
Button	Bartels AutoEngineer (popup) menu button.
ul.ulh	(Hypertext link to) Bartels User Language include file.
ulprog	(Hypertext link to) Bartels User Language program description.
ul.ulc	(Hypertext link to) Bartels User Language program source file.
ul_function	(Hypertext link to) Bartels User Language system function description.
UL_INDEX	(Hypertext link to) Bartels User Language index type description.
utilprog	(Hypertext link to) Bartels AutoEngineer utility program description.
new feature	New features which are made available with regular (weekly) software updates/builds are highlighted in the online documentation.

The character sequences mentioned above may regain original meaning when used in programming languages, interpreter languages, specification languages, syntax description languages, etc.

Copyright

The information contained in the Bartels AutoEngineer publications as well as the products and/or programs described therein are subject to change without notice and should not be construed as a commitment by Bartels System.

Although Bartels System has gone to great effort to verify the integrity of the information provided with the Bartels AutoEngineer publications, these publications could contain technical inaccuracies or typographical errors. Bartels System shall not be liable for errors contained therein or for incidental consequential damages in connection with the furnishing, performance or use of this material. Bartels System appreciates readers' and/or users' comments in order to improve these publications and/or the products described therein. Changes are periodically made to the information therein. These changes will be incorporated in new editions of the Bartels AutoEngineer publications.

All rights reserved. No part of the Bartels AutoEngineer publications may be reproduced, stored in a retrieval system, translated, transcribed or transmitted, in any form or by any means manual, electric, electronic, electromagnetic, mechanical, chemical, optical or otherwise without prior express written permission from Bartels System.

Bartels AutoEngineer®, Bartels Router® and Bartels Autorouter® are registered trademarks of Bartels System. Bartels User Language™ and Bartels Neural Router™ are trademarks of Bartels System. All other products or services mentioned in this publication are identified by the trademarks or service marks of their respective companies or organizations.

Bartels User Language - Programmer's Guide
© 1985-2024 Oliver Bartels F+E • Updated: 11 November 2009, 11:05 [UTC]