Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
typing [2015/04/02 16:17]
christian [specializes] 		typing [2017/09/27 18:45] (current)
christian [Typed Attributes]
Line 1: Line 1:
-====== Typed Attributes ======+====== PDF Object Types ====== 
 + 
 +Objects in PDF have a type and attributes of PDF objects expect to hold objects of a specific type. The types form a hierarchy with **''Object''** as root.  
 + 
 +The PDF type hierarchy is independent of the Smalltalk class hierarchy. Often, the Smalltalk class hierarchy coincides with the PDF type hierarchy, but this is not required. Also, the name of the PDF type can be different from the name of the Smalltalk class, but often they are the same. PDF types and Smalltalk classes are connected by a 1 to 1 relationship: a class can implement only one type and a type can only be implemented by one class. 
 + 
 +A Smalltalk class is declared to represent a PDF type by implementing the class method **''pdfTypeDefinition''** which returns a PDFTypeDefinition object like: 
 + 
 +<code smalltalk> 
 +pdfTypeDefinition 
 +  ^PDFTypeDefinition 
 +    name: #Integer 
 +    supertype: #Number 
 +    section: '7.3.3' 
 +    documentation: 'An integer shall be written as one or more decimal digits optionally preceded by a sign. 
 +The value shall be interpreted as a signed decimal integer and shall be converted to an integer object.' 
 +    version: 0 
 +</code> 
 + 
 +  * ''name'' is a symbol used as type for the type declarations of an attribute. The name should be identical or very similar to the name used in the PDF specification. 
 +  * ''supertype'' denotes the parent type. It is ''nil'' for the top PDF type ''Object''.  
 +  * ''section'' specifies the section of the PDF specification where the type is defined. This will allow the PDF specification to be opened on the documentation of the type.  
 +  * ''documentation'' holds a short description of the type, usually copied (and slightly edited) from the first paragraph in the PDF specification.  
 +  * ''version'' is optional and holds an integer specifying the minor PDF version (mayor version is 1) where the type was introduced. When omitted the version defaults to ''0'' (corresponding to PDF version 1.0). 
 + 
 +''pdfTypeDefinition'' is a special method used to construct the PDF type hierarchy. ALL ''pdfTypeDefinition'' methods shall only construct and return a PDFTypeDefinition object. In order to do so, ALL implementers of ''pdfTypeDefinition'' are collected, evaluated and sorted into the type hierarchy. Therefore, none of the ''pdfTypeDefinition'' methods shall have any side effects. This allows to define a PDF object type independent of the Smalltalk class hierarchy. 
 + 
 +===== Typed Attributes =====
  
 Attributes of Dictionaries are typed. The definition of an Attribute specifies the class/type of the object and wheather the object is directly stored or a reference to it. Attributes of Dictionaries are typed. The definition of an Attribute specifies the class/type of the object and wheather the object is directly stored or a reference to it.
Line 5: Line 32:
 The following pragmas are used for declaring a type: The following pragmas are used for declaring a type:
  
-  * **#type:** *aSymbol* The value (or references) should be of type aSymbol+  * **#type:** *aSymbol* The value (or referenced value) should be of type aSymbol
   * **#typeDirect:** *aSymbol* The value should be of type aSymbol   * **#typeDirect:** *aSymbol* The value should be of type aSymbol
-  * **#typeIndirect:** *aSymbol* The value should be a reference of type aSymbol +  * **#typeIndirect:** *aSymbol* The value should be a reference to an object of type aSymbol 
-  * **#typeArrayOf:** *aSymbol* The value should be an array with values (or references) of type aSymbol +  * **#typeArrayOf:** *aSymbol* The value should be an array with values (or referenced values) of type aSymbol 
-  * **#typeDictionaryOf:** *aSymbol* The value should be a dictionary with values (or references) of type aSymbol+  * **#typeDictionaryOf:** *aSymbol* The value should be a dictionary with values (or referenced values) of type aSymbol
  
 The pragmas can occur several times. One of the given types should apply. The pragmas can occur several times. One of the given types should apply.
Line 17: Line 44:
   <typeArrayOf: #Contents>   <typeArrayOf: #Contents>
 </code> </code>
-The symbol is the type name of the PDF object. So far, the type name corresponds to the class name in the Smalltalk implementation hierarchy.+This declares that the attribute #Contents of a Page can hold either  
 +  * a Contents object or  
 +  * an array of Contents objects.
  
 A type of an object is used when it gets assigned to an attribute. With the type requirement of the attribute, the object is specialized to the attribute type if possible. If this is not possible, a TypeError is raised.  A type of an object is used when it gets assigned to an attribute. With the type requirement of the attribute, the object is specialized to the attribute type if possible. If this is not possible, a TypeError is raised. 
  
-===== Example =====+==== Example ====
  
 The attribute /Root of /Trailer requires a reference to a /Catalog: The attribute /Root of /Trailer requires a reference to a /Catalog:
Line 36: Line 65:
 => TypeError => TypeError
  
-===== Arrays =====+==== Arrays ====
  
 As /Dictionary can be subclassed, so can /Array. The attributes are not named, but accessed positionally with their index. The attributes in subclasses of /Array should be typed and documented like dictionary attributes. For this, the same pragmas as in /Dictionary are used. In /Dictionary the pragma's #attribute:documentation:, the attribute number was only used for sorting. In /Array it is the index of the attribute. As /Dictionary can be subclassed, so can /Array. The attributes are not named, but accessed positionally with their index. The attributes in subclasses of /Array should be typed and documented like dictionary attributes. For this, the same pragmas as in /Dictionary are used. In /Dictionary the pragma's #attribute:documentation:, the attribute number was only used for sorting. In /Array it is the index of the attribute.
Line 57: Line 86:
  
 Rectangle>>ury Rectangle>>ury
-  <attribute: 4 documentation: 'upper right corner x'>+  <attribute: 4 documentation: 'upper right corner y'>
   ^self at: 4   ^self at: 4
 </code> </code>
 Every /Array subclass must implement #numberOfAttributes which is the size of the array. This allows further type checking and the creation of #empty instances with the right number of slots. Every /Array subclass must implement #numberOfAttributes which is the size of the array. This allows further type checking and the creation of #empty instances with the right number of slots.
  
-===== Specializing =====+==== Specializing ====
  
 From the pragmas above types (instances of Type) are created when sending #typesOf: to a Dictionary with the attribute name as argument. Example: From the pragmas above types (instances of Type) are created when sending #typesOf: to a Dictionary with the attribute name as argument. Example:
Line 73: Line 102:
 </code> </code>
  
-==== Extended typing ====+=== Extended typing ===
  
 Typing is extended to be able to group several classes in different implementation hierarchies into an abstract PDF Type. Typing is extended to be able to group several classes in different implementation hierarchies into an abstract PDF Type.
Line 83: Line 112:
 **/Shading** shall be the super type of /ShadingDictionary and /ShadingStream. **/Shading** shall be the super type of /ShadingDictionary and /ShadingStream.
  
-==== subsumes ====+=== subsumes ===
  
  
Line 97: Line 126:
 A PDF object class implements #subsumes: which is simply the test if the object #isKindOf: the class. The supertypes implement this with a list of top classes to which they delegate. A PDF object class implements #subsumes: which is simply the test if the object #isKindOf: the class. The supertypes implement this with a list of top classes to which they delegate.
  
-==== specializes ====+=== specializes ===
  
 <code smalltalk> <code smalltalk>
Line 107: Line 136:
 </code> </code>
 When an object is not a subclass of a type, it can be specialized if the objects class subsumes the type. When an object is not a subclass of a type, it can be specialized if the objects class subsumes the type.
 +
 +
  
  • typing.1427984249.txt.gz
  • Last modified: 2015/04/02 16:17
  • by christian