Update for GemStone 3.5.

Author: James Foster

GciLibrary.py

@@ -8,8 +8,9 @@
 
 class GciLibrary:
 
-    def __init__(self, version='3.4.3', directory=os.getcwd()):
-        self._initLibrary(version, directory)
+    def __init__(self, version='3.5.0'):
+        os.environ["GEMSTONE"] = os.getcwd()
+        self._initLibrary(version, os.getcwd() + '/lib/')
 
         self.gciI32ToOop = self.library.GciI32ToOop
         self.gciI32ToOop.restype = c_int32

GciTests.py

@@ -1,40 +1,49 @@
 """
 >>> # See gcits.hf for details
 
+>>> # obtain an object representing the C library
 >>> gci = GciLibrary()
 >>> isinstance(gci, GciLibrary)
 True
 
+>>> # simplest test to see if we have a GCI library
 >>> gci.version()
-'3.4.3 build gss64_3_4_x_branch-45183'
+'3.5.0 build 64bit-46205'
 
->>> gci.oopToChar(16668)
+>>> # convert a Smalltalk OOP to an ASCII character
+>>> gci.oopToChar(16668)  # $A
 65
 
+>>> # this OOP is not a valid character
 >>> gci.oopToChar(16667)
 -1
 
 >>> gci.oopToChar(24860)  # $a
 97
 
->>> gci.charToOop(65)
+>>> # convert an ASCII code point to a Smalltalk OOP
+>>> gci.charToOop(65) # $A
 16668
 
 >>> gci.charToOop(97) # $a
 24860
 
+>>> # we can convert Unicode as well
 >>> gci.charToOop(1114111)
 285212444
 
+>>> # this is not a valid character, so get back OOP_INVALID (1)
 >>> gci.charToOop(1114112)
 1
 
+>>> # convert a double to a Smalltalk OOP
 >>> try:
 ...     gci.doubleToSmallDouble(1.0)
 ... except InvalidArgumentError:
 ...     "InvalidArgumentError"
 9151314442816847878
 
+>>> # demonstrate that we can properly handle exceptions
 >>> try:
 ...     gci.doubleToSmallDouble(1e40)
 ... except InvalidArgumentError:
@@ -47,6 +56,7 @@
 >>> gci.I32ToOop(55)
 442
 
+>>> # expect an exception for a bad login argument
 >>> try:
 ...     gci.login(gem_host=gem_host, netldi='badldi', stone='badstone')
 ... except GciException as ex:
@@ -65,13 +75,15 @@
 ...     ex.number()     # invalid user/password
 4051
 
+>>> # using the provided login info we should be successful
 >>> session = gci.login(gem_host=gem_host, netldi=netldi, stone=stone, gs_user=gs_user, gs_password=gs_password)
 >>> isinstance(session, int)      # successful login
 True
 
 >>> gci.is_session_valid(session)
 True
 
+>>> # do a name lookup of an object (with a well-known OOP)
 >>> symbolName = 'Globals'
 >>> try:
 ...     gci.resolveSymbol(session, symbolName)
@@ -86,6 +98,7 @@
 ...     ex.number()
 2101
 
+>>> # the following should quietly succeed
 >>> try:
 ...     gci.abort(session)
 ... except GciException as ex:
@@ -101,14 +114,17 @@
 ... except GciException as ex:
 ...     ex.number()
 
+>>> # logout should not error
 >>> try:
 ...     gci.logout(session)
 ... except GciException as ex:
 ...     ex.number()     # invalid session
 
+>>> # session should no longer be valid
 >>> gci.is_session_valid(session)
 False
 
+>>> # subsequent logout attempts should fail
 >>> try:
 ...     gci.logout(session)
 ... except GciException as ex:
@@ -137,12 +153,17 @@
 
 if __name__ == '__main__':
     import os
+    # Create a local login file that is not under version control
     if (not os.path.isfile('GciLogin.py')):
         import shutil
         shutil.copy2('GciDefault.py', 'GciLogin.py')
+    # Import interesting things from GciLibrary
     from GciLibrary import GciLibrary, GciException, InvalidArgumentError
+    # Get local login information (not under version control)
     from GciLogin import *
+    # Import testing framework
     import doctest
     print('Start tests')
+    # Run tests shown in docstring above
     doctest.testmod()
     print('End tests')

README.md

@@ -4,11 +4,17 @@
 
 GemBuilder for C documentation ([HTML](https://downloads.gemtalksystems.com/docs/GemStone64/3.4.x/GS64-GemBuilderC-3.4/GS64-GemBuilderC-3.4.htm) or [PDF](https://downloads.gemtalksystems.com/docs/GemStone64/3.4.x/GS64-GemBuilderforC-3.4.pdf)) describes the API for the *single-threaded* GCI library. We are using a new *thread-safe* library that has fewer functions (but more features). It is not separately documented, but has a header file, `gcits.hf`, that is the definitive specification (a recent copy is included with this checkout).
 
-The needed C libraries are not included as part of this checkout since there is a different set of libraries for each platform (Linux, macOS, and Windows), and for each GemStone version. You should download a recent version and the appropriate [product](https://gemtalksystems.com/products/gs64/) for your platform. Then move the appropriate files into this directory.
-
-* Linux: libfloss-3.4.x-64.so and libgcits-3.4.x-64.so
-* macOS: libfloss-3.4.x-64.dylib and libgcits-3.4.x-64.dylib
-* Windows: libgcits-3.4.x-32.dll and libssl-3.4.x-32.dll
+The needed C libraries are not included as part of this checkout since there is a different set of libraries for each platform (Linux, macOS, and Windows), and for each GemStone version. You should download a recent version and the appropriate [product](https://gemtalksystems.com/products/gs64/) for your platform. Then move the appropriate files into the `./lib/` directory (below this README.md file).
+
+* Linux:
+  * libfloss-3.4.x-64.so and libgcits-3.4.x-64.so
+  * libgcits-3.5.x-64.so, libkrb5-3.5.x-64.so and libssl-3.5.0-64.so 
+* macOS:
+  * libfloss-3.4.x-64.dylib and libgcits-3.4.x-64.dylib
+  * libgcits-3.5.x-64.dylib, libkrb5-3.5.x-64.dylib, and libssl-3.5.0-64.dylib
+* Windows:
+  * libgcits-3.4.x-32.dll and libssl-3.4.x-32.dll
+  * libgcits-3.5.x-32.dll and libssl-3.5.x-32.dll
 
 ## Files