Class: stx_libcompat

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

Inheritance:

   Object
   |
   +--ProjectDefinition
      |
      +--LibraryDefinition
         |
         +--stx_libcompat

Package:

stx:libcompat

Category:

* Projects & Packages *

Version:

rev: 1.176 date: 2024/01/16 18:03:30

user: cg

file: stx_libcompat.st directory: libcompat

module: stx stc-classLibrary: libcompat

Description:

Package documentation

This library contains compatibility classes,
which are useful when loading code from other Smalltalk dialects.

Some of the classes found here are simply empty, but mimic the class hierarchy of
corresponding frameworks in Squeak, VisualWorks, Dolphin or VisualAge Smalltalk dialects.

They usually only allow for an initial fileIn of such imported classes 
(by giving them a superclass to be loaded).
Importing then usually involves further rewrite and debugging - 
especially if the imported code is UI related. 
Non-UI code (model classes) often works out-of-the-box.


[primary maintainer:]
    cg

copyright
COPYRIGHT (c) 2006 by 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

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

 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.

 postLoadAction

invoked after loading a project

 additionalBaseAddressDefinition_bc_dot_mak

(comment from inherited method)
allows for a base-address definition to be added to the bc.mak file.
Subclasses may redefine this to something like
LIB_BASE=$(LIBWIDG_BASE)
This will be inserted BEFORE the 'include stdHeader'

 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

 svnRevisionNr

Return a SVN revision number of myself.
This number is updated after a commit