ExternalStructure.st
author Claus Gittinger <cg@exept.de>
Fri, 05 May 2006 11:41:08 +0200
changeset 9343 0c2dcef80d03
child 9350 7cdbea98454a
permissions -rw-r--r--
initial checkin
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9343
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     1
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     2
 COPYRIGHT (c) 2006 by eXept Software AG
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
              All Rights Reserved
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
 This software is furnished under a license and may be used
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
 hereby transferred.
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
"{ Package: 'stx:libbasic' }"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
ExternalAddress subclass:#ExternalStructure
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
	instanceVariableNames:''
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
	classVariableNames:''
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
	poolDictionaries:''
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
	category:'System-Support'
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
!
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
ExternalStructure class instanceVariableNames:'cType'
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
 No other class instance variables are inherited by this class.
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
!
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
!ExternalStructure class methodsFor:'documentation'!
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
copyright
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
 COPYRIGHT (c) 2006 by eXept Software AG
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
              All Rights Reserved
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
 This software is furnished under a license and may be used
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
 only in accordance with the terms of that license and with the
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
 inclusion of the above copyright notice.   This software may not
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
 be provided or otherwise made available to, or used by, any
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
 other person.  No title to or ownership of the software is
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
 hereby transferred.
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
!
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
documentation
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
    Instances of this class represent external (non-Smalltalk) data,
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
    typically C-structs or C++ instances.
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
    They are only useful to represent handles as returned by C functions as smalltalk objects. 
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
    ExternallStructures are much like ExternalBytes - however, the latter
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
    allow you to access bytes via indexed at:/at:put: messages, whilst instances of subclasses of me
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
    allow access via the corresponding getter/setter methods of my C-type.
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
    [author:]
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
        Claus Gittinger
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
    [see also:]
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
        ExternalBytes ExternalAddress
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
        ( how to write primitive code :html: programming/primitive.html )
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
"
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
! !
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
!ExternalStructure class methodsFor:'queries'!
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
cType
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
    ^ cType
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
! !
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
!ExternalStructure class methodsFor:'documentation'!
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
version
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
    ^ '$Header: /cvs/stx/stx/libbasic/ExternalStructure.st,v 1.1 2006-05-05 09:41:08 cg Exp $'
0c2dcef80d03 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
! !