From baa3e86332b7b7095c899dd7532ac8c127e06553 Mon Sep 17 00:00:00 2001 From: michael Date: Sun, 13 Mar 2005 00:31:54 +0000 Subject: [PATCH] + Many updates and missing identifiers --- docs/baseunix.xml | 175 ++++++ docs/classes.xml | 1526 +++++++++++++++++++++++++++++++++++++++++++++ docs/objects.xml | 17 + docs/prog.tex | 4 +- docs/ref.tex | 5 + docs/unix.xml | 126 +++- docs/unixtype.xml | 42 ++ 7 files changed, 1868 insertions(+), 27 deletions(-) diff --git a/docs/baseunix.xml b/docs/baseunix.xml index fa7b3aba2e..08cafc5dfc 100644 --- a/docs/baseunix.xml +++ b/docs/baseunix.xml @@ -139,6 +139,30 @@ implement the functionality in this unit for the new platform. Pointer to type. + +Alias for + + + +Alias for + + + +Alias for + + + +Alias for + + + +Alias for + + + +Alias for + + Device descriptor type. @@ -1124,6 +1148,140 @@ implement the functionality in this unit for the new platform. Pointer to type. + + +Record describing a timezone + + + + +Minutes west of GMT + + + + +Daylight savings time + + + + +Pointer to record. + + + + +Alias for record. + + + + +File ( record) mode: File type bit mask + + +File ( record) mode: Socket + + +File ( record) mode: Link + + +File ( record) mode: Regular file + + +File ( record) mode: Block device + + +File ( record) mode: Directory + + +File ( record) mode: Character device + + +File ( record) mode: FIFO + + + +Callback prototype for a record. + +When installing a signal handler, the actual signal handler must be of type +SigActionHandler. + + + + +Pointer to record type. + + + +Record describing the CPU context when a signal occurs. + +This type is CPU dependent. Cross-platform code should not use the contents +of this record. + + + + +Pointer to record type. + + + +Record describing the signal when a signal occurs. + +This type describes the signal that occurred. + + + + +Signal number + + + + +Error code + + + +Extra code (?) + + + + +Record describing a file system in the call. + + +File system type + + +Block size + + +Total number of blocks + + +Number of free blocks + + +Number of available blocks + + +Number of files + + +? + + +? + + +Max name length for files. + + +Pad bytes. Do not use. + + + +Extra fields, content depends on the signal. + + map type: Changes are private @@ -4620,6 +4778,23 @@ function. + +Set kernel time + +

+FpSetTimeOfDay sets the kernel time to the number of seconds since 00:00, +January 1 1970, GMT specified in the tp record. This time NOT corrected +any way, not taking into account timezones, daylight savings time and so on. +

+

+It is simply a wrapper to the kernel system call. +

+ + + + + + diff --git a/docs/classes.xml b/docs/classes.xml index 8a32182bd7..6e5e51ad02 100644 --- a/docs/classes.xml +++ b/docs/classes.xml @@ -3355,6 +3355,50 @@ sets the new capacity. + +Return both name and value of a name,value pair based on it's index. + + + + + +Delimiter character used in DelimitedText. + + + + + +Get or set all strings in the list in a delimited form. + + + + + +Quote character used in DelimitedText. + + + + +Value of the character used to separate name,value pairs + + + + + + +Return the value part of a string based on it's index. + + + + + + + + + +Indicates whether locating strings happens in a case sensitive manner. + + Contents of the list as a comma-separated string. @@ -3399,6 +3443,11 @@ String NormalString +

+This is a special case of the property where the +quote character is always the double quote, and the delimiter is always the +colon. +

 @@ -9807,6 +9856,1483 @@ linefeed character. Callback type used in stringlist compares. + + +System routines + + + + +System types + + + + +RTTI information + + + + +Resource strings with messages + + + + +Keyboard/Mouse shift state enumerator + + + + +Shift key pressed + + + + +Alt key pressed + + + + +Ctrl key pressed + + + + +Left mouse button pressed. + + + + +Right mouse button pressed. + + + + +Middle mouse button pressed. + + + + +Double mouse click. + + + + +Meta key pressed. + + + + +Super key pressed. + + + + +Hyper key pressed. + + + + +Alt-GR key pressed. + + + + +Caps lock key pressed + + + + +Num lock key pressed + + + + +Scroll lock key pressed + + + + +Triple mouse click + + + + +Quadruple mouse click + + + + +Help type: Keyword help + + + + +Help type: Context ID help. + + + + +List change notification: Element added to the list. + + + + +List change notification: Element extracted from the list. + + + + +List change notification: Element deleted from the list. + + + + +Remove the first occurrence of a pointer from the list. + +Extract searched for an occurence of item, and if a +match is found, the match is deleted from the list. If no match is found, +nothing is deleted. If Item was found, the result is +Item. If Item was not found, the result is +Nil. A lnExtracted notification event is triggered if +an element is extracted from the list. Note that a lnDeleted +event will also occur. + + + + + + + + + + +Copy the contents of another list. + +Assign copies the pointers of the Obj list to the list. +The list is cleared prior to copying. + + + + + + + + +Helper class for storing published properties + +

+TRecall is a helper class used to copy published +properties of a class (the reference object) in another class +(the storage object). The reference object and storage object must be +assignable to each other. +

+

+The TRecall can be used to store the state of a persistent class, +and restore it at a later time. +

+

When a TRecall object is created, it gets passed a reference +instance and a storage instance. It immediatly stores the properties of +the reference object in the storage object. +

+

+The Store method can be called throughout +the lifetime of the reference object to update the stored properties. +

+

When the TRecall instance is destroyed then the properties are +copied from the storage object to the reference object. The storage object +is freed automatically. +

+

+If the properties should not be copied back from the storage to the +reference object, the Forget can be called. +

+ + + + + + + + + + + + +Creates a new instance of TRecall. + +Create creates a new instance of TRecall and +initializes the Reference and Storage instances. It calls Store to assign the reference object properties to +the storage instance. + + + + + + + + + +Copies the stored properties to the reference object and destroys the +TRecall instance. + +Destroy assigns the storage instance to the reference instance, +if the latter is still valid. After this, it frees the storage and calls the +inherited destroy. + + +Destroy does not check whether the reference instance is still valid. If the +reference pointer was invalidated, call to clear +the reference instance. + + + + + + + + + +Assigns the reference instance to the storage instance. + +

+Store assigns the reference instance to the storage instance. +This will only work if the two classes can be assigned to each other. +

+

+This method can be used to refresh the storage. +

+ + +Store does not check whether the reference instance is still valid. If the +reference pointer was invalidated, call to clear +the reference instance. + + + + + + + +Clear the reference property. + +

+Forget sets the Reference property to +Nil. When the TRecall instance is destroyed, the +reference instance will not be restored. +

+

+Note that after a call to Forget, a call to Store has no effect. +

+ + +None. + + + + + + + + + + +The reference object. + +Reference is the instance of the reference object. Do not free +the reference directly. +Call Forget to clear the reference and then +free the reference object. + + + + + + + + +Collection change notifcation enumeration. + +TCollectionNotification is used in the +class to send notifications about changes to the collection. + + + + + +An item is added to the collection. + + + + +An item is extracted from the collection. + + + + +An item is deleted from the collection. + + + + +Owner of the collection. + +Owner returns a reference to the owner of the collection. This +property is required by the object inspector to be able to show the +collection. + + + + + +Delete an item from the collection. + +Delete deletes the item at (zero based) position +Index from the collection. This will result in a +cnDeleted notification. + + +If an invalid index is specified, an exception is raised. + + + + + + + + + + +Insert an item in the collection. + +

+Insert creates a new item instance and inserts it in +the collection at position Index, and returns the new instance. +

+

+In contrast, adds a new item at the end. +

+ + +None. + + + + + + + + + + +TCollection descendent +which maintains owner information. + +TOwnedCollection automatically maintains owner information, so it +can be displayed in an IDE. Collections that should be displayed in an +IDE should descend from TOwnedCollection or must implement a +GetOwner function. + + + + + + + + +Create a new TOwnerCollection instance. + +Create creates a new instance of TOwnedCollection and +stores the AOwner references. It will the value returned in the property of the collection. The +ItemClass class reference is passed on to the inherited +constructor, and will be used to create new instances in the Insert and Add methods. + + + + + + + + + +Stream which uses a second stream as a source + +TOwnerStream can be used when creating stream chains +such as when using encryption and compression streams. It keeps a reference +to the source stream and will automatically free the source stream when +ready (if the SourceOwner +property is set to True). + + + + + + + + + + +Create a new instance of TOwnerStream. + +Create instantiates a new instance of TOwnerStream and +stores the reference to AStream. If SourceOwner is +True, the soure stream will also be freed when the instance is +destroyed. + + + + + + + + + + +Destroys the TOwnerStream instance and the source stream. + +Destroy frees the source stream if the SourceOwner +property is True. + + + + + + + + + + + + +Reference to the source stream. + +

+Source is the source stream. It should be uses by descendent +streams to access the source stream to read from or write to. +

+

+Do not free the Source reference directly. Either the owner +stream instance should free the source stream or +

+ + + + + + + + +Indicates whether the ownerstream owns it's source + +SourceOwner indicates whether the TOwnerStream owns +it's Source stream or not. If this property is True +then the Source stream is freed when the TOwnerStream +instance is freed. + + + + + + + + + +Overrides the Seek method. + +seek uses the FileSeek +method to position the stream on the desired position. Note that handle +stream descendents (notably pipes) can override the method to prevent the +seek. + + + + + +return the size of the stream. + +GetSize returns the size of the reseved memory. It should not be +used directly. + + + + + + + + +UTF8 encoded unicode string. + + + + +Return the type of the next value. + +

+NextValue returns the type of the next value in a binary stream, +but does not read the value. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read the next value in the stream + +

+NextValue reads the next value in a binary stream and returns +the type of the read value. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Start reading the root component. + +

+BeginRootComponent starts reading the root component in a binary +stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Start reading a component. + +

+

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Start reading a property. + +

+

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Start reading a binary value. + +

+ReadBinary reads a binary valye from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a float value + +

+ReadFloat reads a float value from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a single-size float value + +

+ReadSingle reads a single-sized float value from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a date. + +

+ReadDate reads a date value from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read an identifier + +

+ReadIdent reads an identifier from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read an 8-bits integer. + +

+Read8Int reads an 8-bits signed integer from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a 16-bits integer. + +

+Read16Int reads a 16-bits signed integer from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a 32-bits integer. + +

+Read32Int reads a 32-bits signed integer from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a 64-bits integer. + +

+Read64Int reads a 64-bits signed integer from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a set + +

+ReadSet reads a set from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a short string + +

+ReadStr reads a short string from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Read a string + +

+ReadStr reads a string of type StringType from a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Skip a component's data + +

+SkipComponent skips the data of a component in a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in . +

+ + + + + +Skip a value's data + +

+SkipComponent skips the data of the next value in a binary stream. +

+

+This method is simply the implementation for a binary stream of the abstract method introduced +in +

+ + + + + +Callback for the event. + +TSetMethodPropertyEvent is the prototype for the event. Reader is the sender of +the event, Instance is the instance that is being streamed. +PropInfo is a pointer to the RTTI information for the property +being read, and TheMethodName is the name of the method that +the property should be set to. Handled should be set to +True if the handler set the property succesfully. + + + + + +Callback for the event. + +TPropertyNotFoundEvent is the prototype for the event. Reader is the sender of +the event, Instance is the instance that is being streamed. +PropInfo is a pointer to the RTTI information for the property +being read. Handled should be set to True if +the handler redirected the unknown property succesfully, and Skip +should be set to True if the value should be skipped. +IsPath determines whether the property refers to a sub-property. + + + + + + + + +Callback for the event handler + +TReadWriteStringPropertyEvent is the prototype for the event handler. Reader is the +sender of +the event, Instance is the instance that is being streamed. +PropInfo is a pointer to the RTTI information for the property +being read. Content is the string as it was read from the stream. + + + + + + + + +Handler for treating missing properties. + +

+OnPropertyNotFound can be used to take appropriate action when a +property is read from a stream and no such property is found in the RTTI +information of the Instance that is being read from the stream. It can be +set at runtime, or at designtime by an IDE. +

+

+For more information about the meaning of the various arguments to the event +handler, see . +

+ + + + + + + + + + + +Handler for setting method properties. + +OnSetMethodProperty can be set to handle the setting of method +properties. This handler can be used by an IDE to prevent methods from +actually being when an object is being streamed in the designer. + + + + + + + + + +Handler for translating strings when read from the stream. + +OnReadStringProperty is called whenever a string property is read +from the stream. It can be used e.g. by a translation mechanism to translate the +strings on the fly, when a form is loaded. See for a description of the various +parameters. + + + + + + + + + + +Callback for the event. + +TWriteMethodPropertyEvent is the prototype for the event. Writer is the sender of +the event, Instance is the instance that is being streamed. +PropInfo is a pointer to the RTTI information for the property +being written, and MethodValue is the value of the method that +the property was set to. DefMethodCodeValue is set to the default +value of the property (Nil or the parent value). +Handled should be set to True if the handler set the property succesfully. + + + + + + + + +Handler from writing method properties. + +OnWriteMethodProperty can be set by an IDE or some streaming +mechanism which handles dummy values for method properties; It can be used +to write a real value to the stream which will be interpreted correctly when +the stream is read. See for a description of the arguments. + + + + + + + + + +Event handler for translating strings written to stream. + +OnWriteStringProperty is called whenever a string property is +written to the stream. It can be used e.g. by a translation mechanism to +translate the strings on the fly, when a form is written. See for a description of the various +parameters. + + + + + + + + + + +Exception raised when a thread is destroyed illegally. + + + + +Synchronize callback type + + + + +Exception that occured during thread execution + +FatalException contains the exception that occurred during the +thread's execution. + + + + + +Overrides standard BeforeDestruction. + +BeforeDestruction is overridden by TComponent to set +the csDestroying flag in + + + + + + + + +Standard action execution method. + +ExecuteAction checks whether Action handles the +current component, and if yes, calls the ExecuteAction method, +passing itself as a parameter. The function returns True if the +action handles the current component. + + + + + + + + + + + +Remove a component from the Free Notification list. + +RemoveFreeNotification removes AComponent from the +freenotification list. + + + + + + + + +Updates the state of an action. + +UpdateAction checks whether Action handles the +current component, and if yes, calls the UpdateTarget method, +passing itself as a parameter. The function returns True if the +action handles the current component. + + + + + + + + + + + +Container for non-visual components. + +

+TDataModule is a container for non-visual objects which can be +used in an IDE to group non-visual objects which can be used by various +other containers (forms) in a project. Notably, data access components are +typically stored on a datamodule. Web components and services can also be +implemented as descendents of datamodules. +

+

+TDataModule introduces some events which make it easier to +program, and provides the needed streaming capabilities for persistent +storage. +

+

+An IDE will typically allow to create a descendent of TDataModule +which contains non-visual components in it's published property list. +

+ + + + + + + + +Create a new instance of a TDataModule. + +Create creates a new instance of the TDatamodule +and calls . After that it reads the +published properties from a stream using +if a descendent class is instantiated. If the OldCreateOrder +property is True, the event is called. + + +An exception can be raised during the streaming operation. + + + + + + + + + + +CreateNew creates a new instance of the class, but bypasses the +streaming mechanism. The CreateMode parameter (by default zero) +is not used in TDataModule. If the +handler is set, then it is called, with the newly created instance as an +argument. + + + + + + + + + + +Destroys the TDataModule instance. + +

+Destroy destroys the TDataModule instance. If the +OldCreateOrder property is +True the OnDestroy event +handler is called prior to destroying the data module. +

+

+Before calling the inherited destroy, the +handler is called if it is set, and Self is passed as a +parameter. +

+ + +An event can be raised during the OnDestroy event handler. + + + + + + + + + +Overrides standard TObject behaviour. + +AfterConstruction calls the OnCreate handler if the OldCreateOrder property is +False. + + + + + + + + + + + +BeforeDestruction calls the OnDestroy +handler if the OldCreateOrder property is +False. + + + + + + + + + +Position property needed for manipulation in an IDE. + +DesignOffset is the position of the datamodule when displayed in +an IDE. It is streamed to the form file, and should not be used at run-time. + + + + + + + + +Size property needed for manipulation in an IDE. + +DesignSize is the size of the datamodule when displayed in +an IDE. It is streamed to the form file, and should not be used at run-time. + + + + + + + + +Event handler, called when the datamodule is created. + +The OnCreate event is triggered when the datamodule is created +and streamed. The exact moment of triggering is dependent on the value of +the OldCreateOrder property. + + + + + + + + + + +Event handler, called when the datamodule is destroyed. + +The OnDestroy event is triggered when the datamodule is destroyed +The exact moment of triggering is dependent on the value of the +OldCreateOrder property. + + + + + + + + + + + + +Determines when OnCreate and OnDestroy are +triggered. + +OldCreateOrder determines when exactly the OnCreate and OnDestroy event handlers are called: + + + + + + + + + + + + + + +Handler called when a new TDataModule instance is created. + +AddDataModule can be set by an IDE or a streaming mechanism to +receive notification when a new instance of a +descendent is created. + + + + + + + + + +Handler called when a TDataModule instance is freed. + +RemoveDataModule can be set by an IDE or a streaming mechanism to +receive notification when an instance of a +descendent is freed. + + + + + + + + + +Handler for exceptions when a TDataModule streaming error occurs. + +ApplicationHandleException can be set by an application object to +handle any exceptions that may occur when a is +created. + + + + + + + + +Unused. + + + + + + + + +Check whether there are any synchronize calls in the synchronize queue. + +CheckSynchronize should be called regularly by the main application +thread to handle any calls that may be waiting for +execution by the main thread. + + + + + + + + +Handler which is called if a thread wants to synchronize with the main application thread. + +WakeMainThread is called by the call. +It should alert the main program thread that a thread is waiting for +synchronization. The call is executed by the thread, and should therefore +NOT synchronize the thread, but should somehow signal the main thread that a +thread is waiting for synchronization. For example, by sending a message. + + + + + + + + + +Start new class group. + +

+StartClassGroup starts a new class group and adds AClass to +it. +

+

+The class registration and streaming mechanism allows to organize the classes in +groups. This allows an IDE to form groups of classes, which can be enabled +or disabled. It is not needed at Run-Time. +

+ + + + + + + + + + +Add class to the group of another class. + +

+GroupDescendentsWith adds AClass to the group that +AClassGroup belongs to. If AClassGroup belongs to more +than 1 group, then it is added to the group which contains the nearest +ancestor. +

+

+The class registration and streaming mechanism allows to organize the classes in +groups. This allows an IDE to form groups of classes, which can be enabled +or disabled. It is not needed at Run-Time. +

+ + + + + + + + + + + + +Activates a class group + +

+ActivateClassGroup activates the group of classes to which +AClass belongs. The function returns the class that was last used +to activate the class group. +

+

+The class registration and streaming mechanism allows to organize the classes in +groups. This allows an IDE to form groups of classes, which can be enabled +or disabled. It is not needed at Run-Time. +

+ + +If AClass does not belong to a class group, an exception is +raised. + + + + + + + + + + +Returns the class group to which an instance or class belongs + +ClassGroupOf returns the class group to which AClass +or Instance belongs. + + +The result is Nil if no matching class group is found. + + + + + + + + + + +Callback type for RegisterInitComponentHandler + +TInitComponentHandler is a callback type. It is used in the +InitInheritedComponent call to initialize a component. +Callbacks of this type are registered with the call. + + + + + +Register a component searching handler + +RegisterFindGlobalComponentProc registers a global component +search callback AFindGlobalComponent. When is called, then this callback will be used to +search for the component. + + +None. + + + + + + + + + +Remove a previously registered component searching handler. + +UnRegisterFindGlobalComponentProc unregisters the previously +registered global component search callback AFindGlobalComponent. +After this call, when is called, then this +callback will be no longer be used to search for the component. + + +None. + + + + + + + + + +Register a component initialization handler + +RegisterInitComponentHandler registers a component initialization +handler Handler for the component ComponentClass. This +handler will be used to initialize descendents of +ComponentClass in the call. + + + + + + + + + +Convert a binary buffer to a hexadecimal string + +

+BinToHex converts the byte values in BinValue +to a string consisting of 2-charachter hexadecimal strings in +HexValue. +BufSize specifies the length of BinValue, which means +that HexValue must have size 2*BufSize. +

+

+For example a buffer containing the byte values 255 and 0 will be converted to +FF00. +

+ + +No length checking is done, so if an invalid size is specified, an exception +may follow. + + + + + + + + +Convert a hexadecimal string to a binary buffer + +HexToBin scans the hexadecimal string representation in +HexValue and transforms every 2 character hexadecimal +number to a byte and stores it in BinValue. The buffer size is +the size of the binary buffer. Scanning will stop if the size of the binary +buffer is reached or when an invalid character is encountered. The return +value is the number of stored bytes. + + +No length checking is done, so if an invalid size is specified, an exception +may follow. + + + + + + - -Record describing a timezone - - - - -Minutes west of GMT - - - - -Daylight savings time - - - - -Pointer to record. - - - - -Alias for record. - - File ( record) mode: File type bit mask @@ -2440,6 +2415,107 @@ function. + + map type: Changes are private + + + map type: Don't use a file + + + option: Memory grows downward (like a stack) + + + option: Ignored. + + + option: Ignored. + + + option: lock the pages in memory. + + + option: Do not reserve swap pages for this memory. + + + map type: Share changes + + + map type: Bitmask for type of mapping + + + map type: Interpret addr exactly + + + + memory access: page can be read + + + memory access: page can be written + + + memory access: page can be executed + + + memory access: page can not be accessed + + + +Alias for + + + +Alias for + + + +Alias for + + + +Alias for + + + +Alias for + + + +Alias for + + + +Record describing a file system in the call. + + +File system type + + +Block size + + +Total number of blocks + + +Number of free blocks + + +Number of available blocks + + +Number of files + + +? + + +? + + +Max name length for files. + + +Pad bytes. Do not use. + diff --git a/docs/unixtype.xml b/docs/unixtype.xml index e577a9b869..d7bbc8dd68 100644 --- a/docs/unixtype.xml +++ b/docs/unixtype.xml @@ -126,6 +126,31 @@ sizes and conventions of the platform to which the compiler is ported. Pointer to type. + +C type: 8-bit signed integer + + + +C type: 8-bit unsigned integer + + + +Alias for + + + +Pointer to + + + +Pointer to + + + +Pointer to + + + Device descriptor type. @@ -786,6 +811,23 @@ anytime. Maximum signal number. + + + + option: Get process priority. + + + + + option: Get process group priority. + + + + + option: Get user priority. + + +