comdoc

package

v8.2.0 Latest Latest Go to latest Published: Jan 17, 2025 License: Apache-2.0 Imports: 9 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sassoftware/relic

Links

Open Source Insights

Documentation ¶

Overview ¶

Microsoft Compound Document File Reference: https://www.openoffice.org/sc/compdocfileformat.pdf ERRATA: The above document says the 0th sector is always 512 bytes into the file. This is not correct. If SectorSize > 512 bytes then the 0th sector is SectorSize bytes into the file.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Color ¶

type Color uint8

const (
	Red   Color = 0
	Black Color = 1
)

type ComDoc ¶

type ComDoc struct {
	File            io.ReaderAt
	Header          *Header
	SectorSize      int
	ShortSectorSize int
	FirstSector     int64
	// MSAT is a list of sector IDs holding a SAT
	MSAT []SecID
	// SAT is a table where the index is the sector ID and the value is a pointer to the next sector ID in the same stream
	SAT   []SecID
	SSAT  []SecID
	Files []DirEnt
	// contains filtered or unexported fields
}

CDF file open for reading or writing

func ReadFile ¶

func ReadFile(reader io.ReaderAt) (*ComDoc, error)

Parse an already-open CDF file for reading

func ReadPath ¶

func ReadPath(path string) (*ComDoc, error)

Open a CDF file for reading

func WriteFile ¶

func WriteFile(f *os.File) (*ComDoc, error)

Parse an already-open CDF file for reading and writing

func WritePath ¶

func WritePath(path string) (*ComDoc, error)

Open a CDF file for reading and writing

func (*ComDoc) AddFile ¶

func (r *ComDoc) AddFile(name string, contents []byte) error

Add or replace a named stream with the given contents. Only streams within the root storage are currently supported.

func (*ComDoc) Close ¶

func (r *ComDoc) Close() error

Close the CDF and, if open for writing, commit the remainder of structures to disk.

func (*ComDoc) DeleteFile ¶

func (r *ComDoc) DeleteFile(name string) error

Delete a file from the root storage if it exists

func (*ComDoc) ListDir ¶

func (r *ComDoc) ListDir(parent *DirEnt) ([]*DirEnt, error)

List the items in a storage. If parent is nil, the root storage is used.

func (*ComDoc) ReadStream ¶

func (r *ComDoc) ReadStream(e *DirEnt) (io.Reader, error)

Open a stream for reading

func (*ComDoc) RootStorage ¶

func (r *ComDoc) RootStorage() *DirEnt

Return a pointer to the root storage.

type DirEnt ¶

type DirEnt struct {
	RawDirEnt
	// Index into the directory stream holding this entry
	Index int
	// contains filtered or unexported fields
}

Parsed CDF directory entry

func (DirEnt) Name ¶

func (e DirEnt) Name() string

Return the UTF8 name of this entry

type DirType ¶

type DirType uint8

const (
	DirEmpty   DirType = 0
	DirStorage DirType = 1
	DirStream  DirType = 2
	DirRoot    DirType = 5
)

type Header ¶

type Header struct {
	Magic            [8]byte
	UID              [16]byte
	Revision         uint16
	Version          uint16
	ByteOrder        uint16
	SectorSize       uint16 // power of 2
	ShortSectorSize  uint16 // power of 2
	Reserved1        [6]byte
	DirSectorCount   uint32 // undocumented?
	SATSectors       uint32
	DirNextSector    SecID
	Reserved2        uint32
	MinStdStreamSize uint32
	SSATNextSector   SecID
	SSATSectorCount  uint32
	MSATNextSector   SecID
	MSATSectorCount  uint32
	MSAT             [msatInHeader]SecID
}

Raw CDF file header

type RawDirEnt ¶

type RawDirEnt struct {
	NameRunes   [32]uint16
	NameLength  uint16
	Type        DirType
	Color       Color
	LeftChild   int32
	RightChild  int32
	StorageRoot int32
	UID         [16]byte
	UserFlags   uint32
	CreateTime  uint64
	ModifyTime  uint64
	NextSector  SecID
	StreamSize  uint32
	// contains filtered or unexported fields
}

Raw CDF directory entry

func (RawDirEnt) Name ¶

func (e RawDirEnt) Name() string

Return the UTF8 name of this entry

type SecID ¶

type SecID int32

const (
	SecIDFree       SecID = -1
	SecIDEndOfChain SecID = -2
	SecIDSAT        SecID = -3
	SecIDMSAT       SecID = -4
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL