package edgir.common

Get desktop application:
View/edit binary Protocol Buffers messages

* Placeholder until I figure out how to import properly

Used in: Metadata, elem.BlockLike, elem.LinkLike, elem.PortLike, init.ValInit

(message has no fields)

* Used to communicate results of analysis / checking passes. Limited to Block and Link objects.

Used in: Metadata

• string message = 1

  free-form error message

• string traceback = 3

  full traceback TODO: should there be a structured stack trace?

• repeated SourceLocator source = 2

  source locator, eg line of failing constraint

* Arbitrary metadata stored in tree form.

Used in: Metadata.Members, elem.HierarchyBlock, elem.Link, elem.LinkArray, elem.Port, elem.PortArray, expr.IfThenElseExpr, expr.ValueExpr, impl.BlockImpl, impl.EnvironmentImpl, impl.LinkImpl, impl.PortImpl, init.ValInit, lit.ValueLit, name.LibraryName, name.Namespace, ref.LibraryPath, ref.LocalPath, schema.Library

• oneof type

  * An unknown type just means we don't have some specific expected structure. A known type is shorthand to tell us what fields we should expect and how to decode the stored data. None of this is enforced anywhere, so programmer beware, getting the type and other information right is your job.

  • Empty unknown = 1

  • string known = 2

• oneof meta

  • Metadata.Members members = 101

  • string text_leaf = 102

  • bytes bin_leaf = 103

    * I wanted to split binary and text data, since we might just want to dump a raw file/image/datasheet in here for safekeeping. Mixing up binary and textual formats is just a recipe for trouble.

  • SourceLocator source_locator = 110

    Defined formats Note: key should be the message definition name (eg, SourceLocator) TODO: how to handle multiple metadata of a given type?

  • Error error = 112

Used in: Metadata

• map<string, Metadata> node = 10

* For locating source data

Used in: Error, Metadata

• string file_package = 1

  package name (portable, not tied to an absolute path) that locates the file

• int32 line_offset = 2

  line number

• int32 col_offset = 3

  character offset within the line

• SourceLocator.SourceType source_type = 4

Used in: SourceLocator

• UNKNOWN = 0

• DEFINITION = 1

  source defining this class, would be present in library

• INSTANTIATION = 2

  source of instantiation, would be present in design