MacPlistBinaryDecoder.st
author Claus Gittinger <cg@exept.de>
Mon, 13 Feb 2017 20:44:08 +0100
changeset 4317 03c69a595f88
parent 3624 98bcd94f40a5
child 4343 6ed3f8281ea6
permissions -rw-r--r--
#OTHER by cg comment/format
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3624
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     1
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     2
 COPYRIGHT (c) 2015 by Claus Gittinger
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
              All Rights Reserved
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
 This software is furnished under a license and may be used
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
 hereby transferred.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
"{ Package: 'stx:libbasic2' }"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
"{ NameSpace: Smalltalk }"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
Object subclass:#MacPlistBinaryDecoder
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
	instanceVariableNames:'inputStream'
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
	classVariableNames:''
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
	poolDictionaries:''
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
	category:'System-Support-FileFormats'
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
!MacPlistBinaryDecoder class methodsFor:'documentation'!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
copyright
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
 COPYRIGHT (c) 2015 by Claus Gittinger
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
              All Rights Reserved
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
 This software is furnished under a license and may be used
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
 only in accordance with the terms of that license and with the
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
 inclusion of the above copyright notice.   This software may not
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
 be provided or otherwise made available to, or used by, any
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
 other person.  No title to or ownership of the software is
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
 hereby transferred.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
documentation
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
    A common binary file format representation on Mac OSX.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
    On OSX, this is used to store user preferences, settings and application histories.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
    It is also used to provide additional attributes for applications (such as type of
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    document, icons etc.)
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
    Notice, that OSX is moving towards a new plist format, which is XML based.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
    This decoder reads the old binary format. New applications should use the new format,
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
    and only use this decoder to convert/read old plist files.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
    [author:]
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
        Claus Gittinger
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
    [see also:]
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
        MacPlistXMLDecoder MacPlistXMLCoder
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
    [instance variables:]
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
    [class variables:]
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
examples
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
   restore:
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
                                                                [exBegin]
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
     |inFile d decodedObject|
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
     inFile := '/System/Library/CoreServices/CoreTypes.bundle/Contents/Resources/German.lproj/InfoPlist.strings'.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
     
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
     decodedObject := (MacPlistBinaryDecoder on:inFile asFilename binaryContentsOfEntireFile) decodedObject.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
     decodedObject inspect.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
                                                                [exEnd]
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    75
! !
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    77
!MacPlistBinaryDecoder class methodsFor:'instance creation'!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
on:aByteArrayOrReadStream
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
    Smalltalk requirePackage:'stx:goodies/xml/stx'.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
    
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
    ^ self new on:aByteArrayOrReadStream readStream
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
! !
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
!MacPlistBinaryDecoder methodsFor:'decoding'!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    86
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
decodedObject
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
    "use plutil to convert to XML, then read that"
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    90
    |tmpFile tmpXMLFile decoder object|
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
    tmpFile := '/tmp/a' asFilename. "/ Filename newTemporary.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
    [
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    94
        tmpFile contents:inputStream upToEnd.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    95
        tmpXMLFile := '/tmp/b' asFilename. "/ Filename newTemporary.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    96
        OperatingSystem executeCommand:('plutil -convert xml1 -o %2 %1' bindWith:tmpFile pathName with:tmpXMLFile pathName).
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
        tmpXMLFile readingFileDo:[:s |            
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
            "/ to avoid package dependency from libbasic2 to goodies/xml
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    99
            "/ see package loading on instance-side
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
            decoder := (Smalltalk at:#MacPlistXMLDecoder) on:s.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
            object := decoder decodedObject.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
        ].    
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   103
    ] ensure:[
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
        tmpFile delete.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
        tmpXMLFile delete.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   106
    ].    
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   107
    ^ object.
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   108
! !
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   109
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   110
!MacPlistBinaryDecoder methodsFor:'initialization'!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   111
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   112
on:aStream
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   113
    inputStream := aStream
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   114
! !
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   115
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   116
!MacPlistBinaryDecoder class methodsFor:'documentation'!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   117
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   118
version
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   119
    ^ '$Header$'
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   120
!
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   121
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   122
version_CVS
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   123
    ^ '$Header$'
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   124
! !
98bcd94f40a5 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   125