eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'stx_libbasic':



Class: stx_libbasic



* Projects & Packages *
rev: 1.196 date: 2019/08/10 08:18:17
user: cg
file: stx_libbasic.st directory: libbasic
module: stx stc-classLibrary: libbasic


Package documentation:

This library contains basic (nonGUI) classes.

These are the fundamental classes which are required for any Smalltalk,
whether scripting, non-GUI, repl, IDE or end user application.

Things you find here are mostly classes as described in the ANSI standard.

There are no GUI dependencies here 
(some conditional code deals with the non-presence of UI classes; 
 for example, debugging, for which a non-UI version is provided here)

Also no developer support classes are found here 
(i.e. Change/History support, compiler etc.).

[primary maintainer:]

Class protocol:

o  excludedFromPreRequisites
list all packages which should be ignored in the automatic
preRequisites scan. See #preRequisites for more.

o  mandatoryPreRequisites
list packages which are mandatory as a prerequisite.
This are packages containing superclasses of my classes and classes which
are extended by myself.
They are mandatory, because we need these packages as a prerequisite for loading and compiling.
This method is generated automatically,
by searching along the inheritance chain of all of my classes.
Please take a look at the #referencedPreRequisites method as well.

o  referencedPreRequisites
list packages which are a prerequisite, because they contain
classes which are referenced by my classes.
These packages are NOT needed as a prerequisite for compiling or loading,
however, a class from it may be referenced during execution and having it
unloaded then may lead to a runtime doesNotUnderstand error, unless the caller
includes explicit checks for the package being present.
This method is generated automatically,
by searching all classes (and their packages) which are referenced by my classes.
Please also take a look at the #mandatoryPreRequisites method

description - compilation
o  additionalBaseAddressDefinition_bc_dot_mak
this is an optional definition, which (if present) may speed up the dll-loading a little
on win32 systems.

o  additionalDefinitions_make_dot_proto

o  localIncludes
(comment from inherited method)
allow for the specification of additional include directories

o  stcOptimizationOptions
(comment from inherited method)
see the stc reference / stc usage for options.
Can be redefined in concrete packages.
For now, the following variants are useful:
+optspace3 most compact code
- use for all gui, application code.

+optinline +optinline2 +inlineNew
fastest code
- use only for computation-intensive classes

o  stcWarningOptions

description - contents
o  classNamesAndAttributes
lists the classes which are to be included in the project.
Each entry in the list may be: a single class-name (symbol),
or an array-literal consisting of class name and attributes.
Attributes are: #autoload or #<os> where os is one of win32, unix,...

o  extensionMethodNames
lists the extension methods which are to be included in the project.
Entries are 2-element array literals, consisting of class-name and selector.
A correponding method with real names must be present in my concrete subclasses
if it has extensions.

description - project information
o  companyName
Return a companyname which will appear in <lib>.rc

o  description
Return a description string which will appear in nt.def / bc.def

o  legalCopyright
Return a copyright string which will appear in <lib>.rc

o  productName
Return a product name which will appear in <lib>.rc

description - svn
o  svnRevisionNr
Return a SVN revision number of myself.
This number is updated after a commit

ST/X; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Wed, 06 Dec 2023 05:09:08 GMT