Class: stx_libbasic2

• Inheritance
• Description
• Class protocol
  • description
  • description - compilation
  • description - contents
  • description - project information

Inheritance:

   Object
   |
   +--ProjectDefinition
      |
      +--LibraryDefinition
         |
         +--stx_libbasic2

Package:

stx:libbasic2

Category:

* Projects & Packages *

Version:

rev: 1.246 date: 2024/01/22 13:12:33

user: stefan

file: stx_libbasic2.st directory: libbasic2

module: stx stc-classLibrary: libbasic2

Description:

Package documentation:

This library contains additional basic (nonGUI) classes.

These are less fundamental as in libbasic and not required by many stand alone applications.
Beside additional container classes, this includes URL support, Zip support,
PTY, serial line, sockets and IP addresses, and other less frequently needed things.

Most real world applications will include this, but it is possible to create
small standAlone apps which do not need it.


[primary maintainer:]
    cg

copyright
COPYRIGHT (c) 2006 Claus Gittinger / eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 excludedFromPreRequisites

Rc4Cipher - referenced by RandomGenerator class>>new

 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.
When loading whole packages,
mandatoryPreRequisites will be automatically loaded
BEFORE this packet has been loaded.
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.

 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.
When loading whole packages,
referencedPreRequisites will be automatically loaded
AFTER this packet has been loaded.
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

 subProjects

list packages which are known as subprojects.
The generated makefile will enter those and make there as well.
However: they are only built, not forced to be loaded when a package is loaded;
for those, redefine #referencedPrerequisites or #mandatoryPreRequisites.

 additionalBaseAddressDefinition_bc_dot_mak

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

 additionalLinkLibraries_bc_dot_mak

 additionalLinkLibraries_make_dot_proto

 additionalRules_bc_dot_mak

 additionalRules_make_dot_proto

 additionalTargets_bc_dot_mak

 additionalTargets_make_dot_proto

(comment from inherited method)
can list additional Make.proto targets (additional unix support files)

 localIncludes

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

 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

 stcWarningOptions

 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,...

 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.

 companyName

Return a companyname which will appear in <lib>.rc

 description

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

 legalCopyright

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

 productName

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