package edgir.ref

Get desktop application:
View/edit binary Protocol Buffers messages

* This is a path to an element within a library from the root of a library. To be used as a way to reference such elements.

Used in: elem.BlockLibrary, elem.HierarchyBlock, elem.Link, elem.LinkArray, elem.LinkLike, elem.Port, elem.PortArray, elem.PortLike, edgrpc.hdl.BackendRequest, edgrpc.hdl.GeneratorRequest, edgrpc.hdl.IndexResponse, edgrpc.hdl.LibraryRequest, edgrpc.hdl.RefinementRequest, edgrpc.hdl.Refinements.Subclass, edgrpc.hdl.Refinements.Value.ClassParamPath

• optional name.LibraryName start = 1

• repeated name.Namespace steps = 2

• optional LocalStep target = 3

• optional common.Metadata meta = 255

* This is a path from a local context to some other local context. To be used as a reference.

Used in: elem.Generator, elem.Parameter, expr.AssignExpr, expr.MapExtractExpr, expr.ValueExpr, edgrpc.compiler.CompilerResult.Connection, edgrpc.compiler.CompilerResult.Value, edgrpc.compiler.ErrorRecord, edgrpc.hdl.BackendResponse.Result, edgrpc.hdl.ExprValue, edgrpc.hdl.Refinements.Subclass, edgrpc.hdl.Refinements.Value, edgrpc.hdl.Refinements.Value.ClassParamPath

• repeated LocalStep steps = 1

• optional common.Metadata meta = 255

* This is an actual step you take within the local environment. The directions encode the type of thing we are referencing, but to the user all of these look just like local variables

Used in: LibraryPath, LocalPath

• oneof step

  • Reserved reserved_param = 1

  • string allocate = 2

    Allocates a new element in an array, valid for arrays only. Empty string means automatically allocated, while a non-empty string is a suggested name.

  • string name = 3

    * A local name is what something is called in the context of its parent, whether that parent is a namespace (as in the library) or some other element (as in a design or heirarchy block). localNames should have the following properties: - First char is a lower case letter - All other chars must be letters, numbers, '-', '<', '>' - lowerCamelCase is preffered, don't use any symbols in the name if possible. These are style guidelines, literally any string will work.

* These are reserved terms that we'll end up using in various places. I'd rather have these in the block/link/bridges where they're going to exist, but that's not possible without polymorphism protibuf doesn't have

Used in: LocalStep

• UNDEFINED = 0

• CONNECTED_LINK = 1

  * Directions we could move

• IS_CONNECTED = 40

  * reserved parameters

  true implies CONNECTED_LINK resolves; not available on PortArray

• LENGTH = 42

  EXISTS = 41;

  available on PortArray and LinkArray

• NAME = 44

• ELEMENTS = 45

  available on PortArray and LinkArray, returns a list of string of element names

• ALLOCATED = 46

  cannot be used as a generator dependency

  available on PortArray, returns a list of string of incoming connection names,