mbutterick
/
typesetting
2
1
Fork 0
Code Issues 13 Pull Requests Projects Releases Wiki Activity

portify

Browse Source
main
Matthew Butterick 7 years ago
parent 8a75e8dd09
commit 0433b7b441
2 changed files with 137 additions and 376 deletions
Show Stats Download Patch File Download Diff File

13
pitfall/xenomorph/private/pointer.rkt
Unescape Escape View File

@ -70,22 +70,23 @@ https://github.com/mbutterick/restructure/blob/master/src/Pointer.coffee
(send offset-type size)))
(define/augment (encode stream val [ctx #f])
(define/augment (encode port val [ctx #f])
(if (not val)
(send offset-type encode stream null-value)
(send offset-type encode port null-value)
(let* ([parent ctx]
[ctx (caseq pointer-style
[(local immediate) ctx]
[(parent) (· ctx parent)]
[(global) (find-top-ctx ctx)]
[else (error 'unknown-pointer-style)])]
[relative (+ (caseq pointer-style
[relative (+ (caseq (report pointer-style)
[(local parent) (· ctx startOffset)]
[(immediate) (+ (· stream pos) (send offset-type size val parent))]
[(immediate) (+ (pos port) (send offset-type size val parent))]
[(global) 0])
(relative-getter-or-0 (· parent val)))])
(send offset-type encode stream (- (· ctx pointerOffset) relative))
(report* 'step-1 ctx relative)
(send offset-type encode port (- (· ctx pointerOffset) relative))
(let-values ([(type val) (resolve-void-pointer type val)])
(ref-set! ctx 'pointers (append (· ctx pointers) (list (mhasheq 'type type

500
pitfall/xenomorph/test/pointer-test.rkt
Unescape Escape View File

@ -9,465 +9,225 @@ https://github.com/mbutterick/restructure/blob/master/test/Pointer.coffee
;describe 'Pointer', ->
; describe 'decode', ->
; it 'should handle null pointers', ->
; stream = new DecodeStream new Buffer [0]
; pointer = new Pointer uint8, uint8
; should.not.exist pointer.decode(stream, _startOffset: 50)
(parameterize ([current-input-port (open-input-bytes (bytes 0))])
(check-false (decode (+Pointer uint8 uint8) #:parent (mhash '_startOffset 50))))
(let ([stream (open-input-bytes (bytes 0))]
[pointer (+Pointer uint8 uint8)])
(check-false (decode pointer stream #:parent (mhash '_startOffset 50))))
;
; it 'should use local offsets from start of parent by default', ->
; stream = new DecodeStream new Buffer [1, 53]
; pointer = new Pointer uint8, uint8
; pointer.decode(stream, _startOffset: 0).should.equal 53
(parameterize ([current-input-port (open-input-bytes (bytes 1 53))])
(check-equal? (decode (+Pointer uint8 uint8) #:parent (mhash '_startOffset 0)) 53))
(let ([stream (open-input-bytes (bytes 1 53))]
[pointer (+Pointer uint8 uint8)])
(check-equal? (decode pointer stream #:parent (mhash '_startOffset 0)) 53))
;
; it 'should support immediate offsets', ->
; stream = new DecodeStream new Buffer [1, 53]
; pointer = new Pointer uint8, uint8, type: 'immediate'
; pointer.decode(stream).should.equal 53
(parameterize ([current-input-port (open-input-bytes (bytes 1 53))])
(check-equal? (decode (+Pointer uint8 uint8 (mhash 'type 'immediate))) 53))
(let ([stream (open-input-bytes (bytes 1 53))]
[pointer (+Pointer uint8 uint8 (mhash 'type 'immediate))])
(check-equal? (decode pointer stream) 53))
;
; it 'should support offsets relative to the parent', ->
; stream = new DecodeStream new Buffer [0, 0, 1, 53]
; stream.pos = 2
; pointer = new Pointer uint8, uint8, type: 'parent'
; pointer.decode(stream, parent: _startOffset: 2).should.equal 53
(let ([stream (open-input-bytes (bytes 0 0 1 53))]
[pointer (+Pointer uint8 uint8 (mhash 'type 'parent))])
(pos stream 2)
(check-equal? (decode pointer stream #:parent (mhash 'parent (mhash '_startOffset 2))) 53))
(parameterize ([current-input-port (open-input-bytes (bytes 0 0 1 53))])
(pos (current-input-port) 2)
(check-equal? (decode (+Pointer uint8 uint8 (mhash 'type 'parent))
#:parent (mhash 'parent (mhash '_startOffset 2))) 53))
;
; it 'should support global offsets', ->
; stream = new DecodeStream new Buffer [1, 2, 4, 0, 0, 0, 53]
; pointer = new Pointer uint8, uint8, type: 'global'
; stream.pos = 2
; pointer.decode(stream, parent: parent: _startOffset: 2).should.equal 53
(let ([stream (open-input-bytes (bytes 1 2 4 0 0 0 53))]
[pointer (+Pointer uint8 uint8 (mhash 'type 'global))])
(pos stream 2)
(check-equal? (decode pointer stream #:parent (mhash 'parent (mhash 'parent (mhash '_startOffset 2)))) 53))
(parameterize ([current-input-port (open-input-bytes (bytes 1 2 4 0 0 0 53))])
(pos (current-input-port) 2)
(check-equal? (decode (+Pointer uint8 uint8 (mhash 'type 'global))
#:parent (mhash 'parent (mhash 'parent (mhash '_startOffset 2))))
53))
; it 'should support offsets relative to a property on the parent', ->
; stream = new DecodeStream new Buffer [1, 0, 0, 0, 0, 53]
; pointer = new Pointer uint8, uint8, relativeTo: 'parent.ptr'
; pointer.decode(stream, _startOffset: 0, parent: ptr: 4).should.equal 53
(let ([stream (open-input-bytes (bytes 1 0 0 0 0 53))]
[pointer (+Pointer uint8 uint8 (mhash 'relativeTo (λ (ctx) (· ctx parent ptr))))])
(check-equal? (decode pointer stream #:parent (mhash '_startOffset 0 'parent (mhash 'ptr 4))) 53))
(parameterize ([current-input-port (open-input-bytes (bytes 1 0 0 0 0 53))])
(check-equal? (decode (+Pointer uint8 uint8 (mhash 'relativeTo (λ (ctx) (· ctx parent ptr))))
#:parent (mhash '_startOffset 0 'parent (mhash 'ptr 4)))
53))
;
; it 'should support returning pointer if there is no decode type', ->
; stream = new DecodeStream new Buffer [4]
; pointer = new Pointer uint8, 'void'
; pointer.decode(stream, _startOffset: 0).should.equal 4
(let ([stream (open-input-bytes (bytes 4))]
[pointer (+Pointer uint8 'void)])
(check-equal? (decode pointer stream #:parent (mhash '_startOffset 0)) 4))
(parameterize ([current-input-port (open-input-bytes (bytes 4))])
(check-equal? (decode (+Pointer uint8 'void)
#:parent (mhash '_startOffset 0)) 4))
; it 'should support decoding pointers lazily', ->
; stream = new DecodeStream new Buffer [1, 53]
; struct = new Struct
; ptr: new Pointer uint8, uint8, lazy: yes
;
; res = struct.decode(stream)
; Object.getOwnPropertyDescriptor(res, 'ptr').get.should.be.a('function')
; Object.getOwnPropertyDescriptor(res, 'ptr').enumerable.should.equal(true)
; res.ptr.should.equal 53
(let ([stream (open-input-bytes (bytes 1 53))]
[struct (+Struct (dictify 'ptr (+Pointer uint8 uint8 (mhasheq 'lazy #t))))])
(define res (decode struct stream))
(parameterize ([current-input-port (open-input-bytes (bytes 1 53))])
(define res (decode (+Struct (dictify 'ptr (+Pointer uint8 uint8 (mhasheq 'lazy #t))))))
(check-true (LazyThunk? (hash-ref (get-field _kv res) 'ptr)))
(check-equal? (· res ptr) 53))
; describe 'size', ->
; it 'should add to local pointerSize', ->
; pointer = new Pointer uint8, uint8
; ctx = pointerSize: 0
; pointer.size(10, ctx).should.equal 1
; ctx.pointerSize.should.equal 1
(let ([pointer (+Pointer uint8 uint8)]
[ctx (mhash 'pointerSize 0)])
(check-equal? (size pointer 10 ctx) 1)
(let ([ctx (mhash 'pointerSize 0)])
(check-equal? (size (+Pointer uint8 uint8) 10 ctx) 1)
(check-equal? (· ctx pointerSize) 1))
;
; it 'should add to immediate pointerSize', ->
; pointer = new Pointer uint8, uint8, type: 'immediate'
; ctx = pointerSize: 0
; pointer.size(10, ctx).should.equal 1
; ctx.pointerSize.should.equal 1
(let ([pointer (+Pointer uint8 uint8 (mhash 'type 'immediate))]
[ctx (mhash 'pointerSize 0)])
(check-equal? (size pointer 10 ctx) 1)
(let ([ctx (mhash 'pointerSize 0)])
(check-equal? (size (+Pointer uint8 uint8 (mhash 'type 'immediate)) 10 ctx) 1)
(check-equal? (· ctx pointerSize) 1))
;
; it 'should add to parent pointerSize', ->
; pointer = new Pointer uint8, uint8, type: 'parent'
; ctx = parent: pointerSize: 0
; pointer.size(10, ctx).should.equal 1
; ctx.parent.pointerSize.should.equal 1
(let ([pointer (+Pointer uint8 uint8 (mhash 'type 'parent))]
[ctx (mhash 'parent (mhash 'pointerSize 0))])
(check-equal? (size pointer 10 ctx) 1)
(let ([ctx (mhash 'parent (mhash 'pointerSize 0))])
(check-equal? (size (+Pointer uint8 uint8 (mhash 'type 'parent)) 10 ctx) 1)
(check-equal? (· ctx parent pointerSize) 1))
;
; it 'should add to global pointerSize', ->
; pointer = new Pointer uint8, uint8, type: 'global'
; ctx = parent: parent: parent: pointerSize: 0
; pointer.size(10, ctx).should.equal 1
; ctx.parent.parent.parent.pointerSize.should.equal 1
(let ([pointer (+Pointer uint8 uint8 (mhash 'type 'global))]
[ctx (mhash 'parent (mhash 'parent (mhash 'parent (mhash 'pointerSize 0))))])
(check-equal? (size pointer 10 ctx) 1)
(let ([ctx (mhash 'parent (mhash 'parent (mhash 'parent (mhash 'pointerSize 0))))])
(check-equal? (size (+Pointer uint8 uint8 (mhash 'type 'global)) 10 ctx) 1)
(check-equal? (· ctx parent parent parent pointerSize) 1))
; it 'should handle void pointers', ->
; pointer = new Pointer uint8, 'void'
; ctx = pointerSize: 0
; pointer.size(new VoidPointer(uint8, 50), ctx).should.equal 1
; ctx.pointerSize.should.equal 1
(let ([pointer (+Pointer uint8 'void)]
[ctx (mhash 'pointerSize 0)])
(check-equal? (size pointer (+VoidPointer uint8 50) ctx) 1)
(check-equal? (· ctx pointerSize) 1))
(let ([ctx (mhash 'pointerSize 0)])
(check-equal? (size (+Pointer uint8 'void) (+VoidPointer uint8 50) ctx) 1)
(check-equal? (· ctx pointerSize) 1))
;
; it 'should throw if no type and not a void pointer', ->
; pointer = new Pointer uint8, 'void'
; ctx = pointerSize: 0
; should.throw ->
; pointer.size(30, ctx).should.equal 1
(let ([pointer (+Pointer uint8 'void)]
[ctx (mhash 'pointerSize 0)])
(check-exn exn:fail:contract? (λ () (size pointer 30 ctx))))
(let ([ctx (mhash 'pointerSize 0)])
(check-exn exn:fail:contract? (λ () (size (+Pointer uint8 'void) 30 ctx))))
; it 'should return a fixed size without a value', ->
; pointer = new Pointer uint8, uint8
; pointer.size().should.equal 1
(let ([pointer (+Pointer uint8 uint8)])
(check-equal? (size pointer) 1))
(check-equal? (size (+Pointer uint8 uint8)) 1)
;
; describe 'encode', ->
; it 'should handle null pointers', (done) ->
; stream = new EncodeStream
; stream.pipe concat (buf) ->
; buf.should.deep.equal new Buffer [0]
; done()
;
; ptr = new Pointer uint8, uint8
; ctx =
; pointerSize: 0,
; startOffset: 0,
; pointerOffset: 0,
; pointers: []
;
; ptr.encode(stream, null, ctx)
; ctx.pointerSize.should.equal 0
;
; stream.end()
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 uint8)]
[ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 0
'pointers null)])
(encode ptr #f stream #:parent ctx)
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 0
'pointers null))
(encode (+Pointer uint8 uint8) #f #:parent ctx)
(check-equal? (· ctx pointerSize) 0)
(check-equal? (dump stream) (+Buffer '(0))))
(check-equal? (dump (current-output-port)) (bytes 0)))
;
; it 'should handle local offsets', (done) ->
; stream = new EncodeStream
; stream.pipe concat (buf) ->
; buf.should.deep.equal new Buffer [1]
; done()
;
; ptr = new Pointer uint8, uint8
; ctx =
; pointerSize: 0,
; startOffset: 0,
; pointerOffset: 1,
; pointers: []
;
; ptr.encode(stream, 10, ctx)
; ctx.pointerOffset.should.equal 2
; ctx.pointers.should.deep.equal [
; { type: uint8, val: 10, parent: ctx }
; ]
;
; stream.end()
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 uint8)]
[ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null)])
(encode ptr stream 10 ctx)
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null))
(encode (+Pointer uint8 uint8) 10 #:parent ctx)
(check-equal? (· ctx pointerOffset) 2)
(check-equal? (· ctx pointers) (list (mhasheq 'type uint8
'val 10
'parent ctx)))
(check-equal? (dump stream) (+Buffer '(1))))
'val 10
'parent ctx)))
(check-equal? (dump (current-output-port)) (bytes 1)))
;
; it 'should handle immediate offsets', (done) ->
; stream = new EncodeStream
; stream.pipe concat (buf) ->
; buf.should.deep.equal new Buffer [0]
; done()
;
; ptr = new Pointer uint8, uint8, type: 'immediate'
; ctx =
; pointerSize: 0,
; startOffset: 0,
; pointerOffset: 1,
; pointers: []
;
; ptr.encode(stream, 10, ctx)
; ctx.pointerOffset.should.equal 2
; ctx.pointers.should.deep.equal [
; { type: uint8, val: 10, parent: ctx }
; ]
;
; stream.end()
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 uint8 (mhash 'type 'immediate))]
[ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null)])
(encode ptr stream 10 #:parent ctx)
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null))
(encode (+Pointer uint8 uint8 (mhash 'type 'immediate)) 10 #:parent ctx)
(check-equal? (· ctx pointerOffset) 2)
(check-equal? (· ctx pointers) (list (mhasheq 'type uint8
'val 10
'parent ctx)))
(check-equal? (dump stream) (+Buffer '(0))))
'val 10
'parent ctx)))
(check-equal? (dump (current-output-port)) (bytes 0)))
;
; it 'should handle offsets relative to parent', (done) ->
; stream = new EncodeStream
; stream.pipe concat (buf) ->
; buf.should.deep.equal new Buffer [2]
; done()
;
; ptr = new Pointer uint8, uint8, type: 'parent'
; ctx =
; parent:
; pointerSize: 0,
; startOffset: 3,
; pointerOffset: 5,
; pointers: []
;
; ptr.encode(stream, 10, ctx)
; ctx.parent.pointerOffset.should.equal 6
; ctx.parent.pointers.should.deep.equal [
; { type: uint8, val: 10, parent: ctx }
; ]
;
; stream.end()
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 uint8 (mhash 'type 'parent))]
[ctx (mhash 'parent (mhash 'pointerSize 0
'startOffset 3
'pointerOffset 5
'pointers null))])
(encode ptr stream 10 #:parent ctx)
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'parent (mhash 'pointerSize 0
'startOffset 3
'pointerOffset 5
'pointers null)))
(encode (+Pointer uint8 uint8 (mhash 'type 'parent)) 10 #:parent ctx)
(check-equal? (· ctx parent pointerOffset) 6)
(check-equal? (· ctx parent pointers) (list (mhasheq 'type uint8
'val 10
'parent ctx)))
(check-equal? (dump stream) (+Buffer '(2))))
'val 10
'parent ctx)))
(check-equal? (dump (current-output-port)) (bytes 2)))
;
; it 'should handle global offsets', (done) ->
; stream = new EncodeStream
; stream.pipe concat (buf) ->
; buf.should.deep.equal new Buffer [5]
; done()
;
; ptr = new Pointer uint8, uint8, type: 'global'
; ctx =
; parent:
; parent:
; parent:
; pointerSize: 0,
; startOffset: 3,
; pointerOffset: 5,
; pointers: []
;
; ptr.encode(stream, 10, ctx)
; ctx.parent.parent.parent.pointerOffset.should.equal 6
; ctx.parent.parent.parent.pointers.should.deep.equal [
; { type: uint8, val: 10, parent: ctx }
; ]
;
; stream.end()
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 uint8 (mhash 'type 'global))]
[ctx (mhash 'parent
(mhash 'parent
(mhash 'parent (mhash 'pointerSize 0
'startOffset 3
'pointerOffset 5
'pointers null))))])
(encode ptr stream 10 #:parent ctx)
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'parent
(mhash 'parent
(mhash 'parent (mhash 'pointerSize 0
'startOffset 3
'pointerOffset 5
'pointers null)))))
(encode (+Pointer uint8 uint8 (mhash 'type 'global)) 10 #:parent ctx)
(check-equal? (· ctx parent parent parent pointerOffset) 6)
(check-equal? (· ctx parent parent parent pointers) (list (mhasheq 'type uint8
'val 10
'parent ctx)))
(check-equal? (dump stream) (+Buffer '(5))))
'val 10
'parent ctx)))
(check-equal? (dump (current-output-port)) (bytes 5)))
;
; it 'should support offsets relative to a property on the parent', (done) ->
; stream = new EncodeStream
; stream.pipe concat (buf) ->
; buf.should.deep.equal new Buffer [6]
; done()
;
; ptr = new Pointer uint8, uint8, relativeTo: 'ptr'
; ctx =
; pointerSize: 0,
; startOffset: 0,
; pointerOffset: 10,
; pointers: []
; val:
; ptr: 4
;
; ptr.encode(stream, 10, ctx)
; ctx.pointerOffset.should.equal 11
; ctx.pointers.should.deep.equal [
; { type: uint8, val: 10, parent: ctx }
; ]
;
; stream.end()
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 uint8 (mhash 'relativeTo (λ (ctx) (· ctx ptr))))]
[ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 10
'pointers null
'val (mhash 'ptr 4))])
(encode ptr stream 10 #:parent ctx)
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 10
'pointers null
'val (mhash 'ptr 4)))
(encode (+Pointer uint8 uint8 (mhash 'relativeTo (λ (ctx) (· ctx ptr)))) 10 #:parent ctx)
(check-equal? (· ctx pointerOffset) 11)
(check-equal? (· ctx pointers) (list (mhasheq 'type uint8
'val 10
'parent ctx)))
(check-equal? (dump stream) (+Buffer '(6))))
'val 10
'parent ctx)))
(check-equal? (dump (current-output-port)) (bytes 6)))
;
; it 'should support void pointers', (done) ->
; stream = new EncodeStream
; stream.pipe concat (buf) ->
; buf.should.deep.equal new Buffer [1]
; done()
;
; ptr = new Pointer uint8, 'void'
; ctx =
; pointerSize: 0,
; startOffset: 0,
; pointerOffset: 1,
; pointers: []
;
; ptr.encode(stream, new VoidPointer(uint8, 55), ctx)
; ctx.pointerOffset.should.equal 2
; ctx.pointers.should.deep.equal [
; { type: uint8, val: 55, parent: ctx }
; ]
;
; stream.end()
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 'void)]
[ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null)])
(encode ptr stream (+VoidPointer uint8 55) #:parent ctx)
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null))
(encode (+Pointer uint8 'void) (+VoidPointer uint8 55) #:parent ctx)
(check-equal? (· ctx pointerOffset) 2)
(check-equal? (· ctx pointers) (list (mhasheq 'type uint8
'val 55
'parent ctx)))
(check-equal? (dump stream) (+Buffer '(1))))
'val 55
'parent ctx)))
(check-equal? (dump (current-output-port)) (bytes 1)))
;
; it 'should throw if not a void pointer instance', ->
; stream = new EncodeStream
; ptr = new Pointer uint8, 'void'
; ctx =
; pointerSize: 0,
; startOffset: 0,
; pointerOffset: 1,
; pointers: []
;
; should.throw ->
; ptr.encode(stream, 44, ctx)
(let ([stream (open-output-bytes)]
[ptr (+Pointer uint8 'void)]
[ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null)])
(check-exn exn:fail:contract? (λ () (encode ptr stream 44 #:parent ctx))))
(parameterize ([current-output-port (open-output-bytes)])
(define ctx (mhash 'pointerSize 0
'startOffset 0
'pointerOffset 1
'pointers null))
(check-exn exn:fail:contract? (λ () (encode (+Pointer uint8 'void) 44 #:parent ctx))))

Write Preview
Loading…
Cancel
Save