Assembler support for image operands from Rev31

Rev32 and later add many more image operands, and
rearrange their values.

Let EncodeAndDecodeSuccessfully remove preamble comments.

Clean up code for encoding literal operands.

Remove SPV_OPERAND_TYPE_VARIABLE_MEMORY_ACCESS

If a memory mask operand is present, it is a mask.  The mask appears
only once, so just use SPV_OPERAND_TYPE_OPTIONAL_MEMORY_MASK.

The "variable literals" aspect comes into play as follows: if the
Aligned bit is set in the mask, then the parser will be made to
expect the alignment value as a literal number operand that follows
the mask.  That is done through mask operand expansion.

Assembler: mask expressions where 1 bits imply operands

Properly support a memory access mask with a combination
of bits, including the Aligned bit. When the Aligned bit is
set, the parser should expect an alignment value literal operand.

Document the syntax of mask expressions

Assembler support for simple mask expressions

For example, support combining mask enums with "|",
such as "NotNaN|AllowRecip" for the fast math mode.

This is supported for mask values that don't modify the
expected operand pattern:
 - fast math mode
 - function control
 - loop control
 - selection control

TODO: disassembler support to print them as mask expressions.

Generalize spvOperandTableNameLookup to take string length.

This is preparation for parsing mask expressions.

Forbid !<integer> preceding or succeeding '='.

Assembler test for Dim, ImageFormat enums.

Adds SPV_OPERAND_TYPE_SAMPLER_IMAGE_FORMAT, and the
translation tables for its values from the spv::ImageFormat values.

Document inability to use names from 3.12, 1.13

You can't use names from 3.12 Image Channel Order and
3.13 Image Channel Data Type since in the intstruction grammar,
they are only used as return values, but never named arguments
to instructions.

Use generalized EnumCase in AccessQualifier assembly tests

This is in preparation for coming tests that will also
use the templated EnumCase instead of making their
own structs.

Also reformat AccessQualifier test.

Handle IDs among !<integer> operands.

Assembler test for SamplerAddressingMode, SamplerFilterMode

Uses OpConstantSampler instruction.

Assembler test for Storage Class enum values

This covers the storage classes in SPIR-V Rev31.  Rev32 has more.

Support multiple word literal numbers as constants.

Add a new operand type SPV_OPERAND_TYPE_MULTIWORD_LITERAL_NUMBER
to represent those operands that can expand into multiple words.
Now only OpConstant and OpSpecConstant have such kind of operand.

Update CHANGES and Future Work

Assembler test for ExecutionScope, with OpGroupIAdd

Use spvOperandTypeStr to generalize the error message
for failure to parse an ID.
Extend spvOperandTypeStr to cover SPV_OPERAND_TYPE_EXECUTION_SCOPE.

Assembler test for OpTypePipe

Covers all AccessQualifier enums.

In Rev32, OpTypePipe no longer has a type argument.
Added TODOs for this.

Assembler test for single-valued Memory Access flag.

Assembler test for single-valued FunctionControl mask

Fixed name of "Inline" enumerant.

Support for combinations of function control masks should come later.

Remove useless variable.

Assembler test for single-valued LoopControl mask

Support for combining masks should come later.

Assembler test for single-valued SelectionControl mask

Support for combining masks should come later.

Clarify the syntax. Some named enumerants are unusable

You can't use a named enumerant if it's only meaningful
in an operand supplied as an ID to a target instruction.
The place where you'd use the name is something like an
OpConstant, but there's not enough context to bring those
names into scope, unless you're willing to tolerate
potential collisions.

Occurs for the names in:
- 3.25 Memory Semantics
- 3.27 Scope ID
- 3.29 Kernel Enqueue Flags
- 3.30 Kernel Profiling Info

Simplify code for handling literals in disassembler.

Move the syntax description into its own file

Add patch for generating opcode.inc syntax table.

Run clang-format.

Assembler test for OpExecutionMode

Assembler test for OpEntryPoint

Simplify format indication in CompileSuccesfully().

Limit the use of spvCheck and spvCheckReturn to validator.

spvCheck is indeed just an if-statement. Defining such a macro
doesn't help much.

Update readme with latest news.

Move bitwisecast.h to source/ and add include guard.

Fix an infinite loop during message generation.

Rename getWord to spvGetWord and unit test it.

Add option to change assembly syntax format in the dis tool.

Handle operands when OpCode is !<integer>.

Add TODO for capability dependencies for Rev32+

Assembler test for OpMemoryModel

Add library function parameter to set assembly format for disassembler.

Add option to change assembly syntax format in the as tool.

Assembler tests for OpCapability.

Adds test file for instructions in the Mode-Setting section
of the SPIR-V spec.

Assembler test for LinkageAttributes decorations

Assembler tests for all decorations except Linkage attributes

Fixes typos in various parser tables.

Updates readme.md with the fixes.

Run clang-format.

Add an API parameter to choose assembly syntax format for assembler.

Added a new enum for supported assembly syntax formats:
Canonical Assembly Format (CAF) and Assignment Assembly Format (AAF).

Updated assembler interface functions to support choice of assembly
syntax format.

Simplify checking for !<integer> first word.

Assembler test for OpSourceExtension.

Add test utility function MakeVector(std::string) to encode
a string as a vector of 32-bit words, as per the SPIR-V literal
string encoding.

Added missing diagnostic when disassembling empty file.

Added diagnostic messages for what should be an internal failure
that never happens. I figure if we return "failed" for something the
user cannot control we should print a message for it.

Test assembly of OpSource using all language enums

Adds a file to test assembly of instructions in the "Debug" section
of the SPIR-V spec.

Update CHANGES in the readme.md

Avoid undefined pointer given to spvTextDestroy

The undefined pointer might get through to the call
to spvTextDestroy if the test fails on an earlier step.
In that case I just want to see the test failure, and
not a test failure followed by undefined behaviour.

Fix build on MSC

Visual C++ compiler doesn't allow ternary select where type depends on
condition even if there is a user-defined conversion operator to a common
type.

Add OpNop, OpUndef tests for spvTextToBinary

Add text_fixture::TextToBinaryTestBase::CompiledInstructions,
to more easily just examine the generated instructions by skipping
over the header.

Add spvtest::MakeInstruction utility function to easily generate
a vector containing an opcode and its operands.

Fix interface function calls to the new API.

Preserve float values during encoding and decoding roundtrip.

Removed the ambiguity in the API for cleaning input vs output data.

Previous the api used spv_text_t and spv_binary_t for both input
and output, but depending on the usage, you either MUST
call spvBinaryDestroy or you MUST NOT call spvBinaryDestroy on the
pointer.

Simplify uses of spvBinaryDestroy in tests

Always try to destroy the binary during common methods
of test fixtures.  This is safe if no other code in the test
attempted to destroy the binary.

Take advantage of the fact spvBinaryDestroy is a no-op on a nullptr,
by eliminating the null pointer check in the caller.

spvTextDestroy is no-op on nullptr.

Fix spvBinaryDestroy test to use an API-created object

Enable OpcodeMake test, by sampling values.

The previous version of the test was disabled, presumably
because it took to long to run.

spvBinaryDestroy(nullptr) is a no-op.

Remove spvOpcodeIsVariable

Nothing was using it.

Fix -p on disassembler.

spvTextToBinary fails if printing option is on
*and* you send in a non-null pointer-to-spv_text.

Add hex-format tests for !<integer>.

Add invalid-operand tests for !<integer>.

Make all SpirvVectors const in ImmediateInt.cpp.

Tests for parsing recognizable words after !<integer>.

Add disabled test to check float value parsing

Disabled for now because float parsing is broken.

Remove SPV_OPERAND_TYPE_ELLIPSIS

Added option to only compile spirv library instead of all binaries as well

Print diagnostics at the beginning of input.

A spv_diagnostic_t value knows if the source is textual rather
than binary.

Avoid "operands" in the !<immediate> explanation.

Also declare "!<integer> = OpCode" legal.

Document current support and known bugs.

Test consecutive opcodes being !<integer>.

Use opcode operand definitions from SPIR-V specification generator.

The assembler and disassembler now use a dynamically adjusted
sequence of expected operand types.  (Internally, it is a deque,
for readability.)  Both parsers repeatedly pull an expected operand
type from the left of this pattern list, and try to match the next
input token against it.

The expected pattern is adjusted during the parse to accommodate:
- an extended instruction's expected operands, depending on the
  extended instruction's index.
- when an operand itself has operands
- to handle sequences of zero or more operands, or pairs of
  operands.  These are expanded lazily during the parse.

Adds spv::OperandClass from the SPIR-V specification generator.

Modifies spv_operand_desc_t:
 - adds hasResult, hasType, and operandClass array to the opcode
description type.
 - "wordCount" is replaced with "numTypes", which counts the number
   of entries in operandTypes.  And each of those describes a
   *logical* operand, including the type id for the instruction,
   and the result id for the instruction.  A logical operand could be
   variable-width, such as a literal string.

Adds opcode.inc, an automatically-generated table of operation
descriptions, with one line to describe each core instruction.
Externally, we have modified the SPIR-V spec doc generator to
emit this file.
(We have hacked this copy to use the old semantics for OpLine.)

Inside the assembler, parsing an operand may fail with new
error code SPV_FAIL_MATCH.  For an optional operand, this is not
fatal, but should trigger backtracking at a higher level.

The spvTextIsStartOfNewInst checks the case of the third letter
of what might be an opcode.  So now, "OpenCL" does not look like
an opcode name.

In assembly, the EntryPoint name field is mandatory, but can be
an empty string.

Adjust tests for changes to:
- OpSampedImage
- OpTypeSampler

Print failing assembly text in CompileSuccessfully().

Remove unused struct "bin"

More !<integer> tests.

Use spvOpcodeMake() in ImmediateInt tests.

Don't overload operators in std namespace.

Use a spvtest::WordVector proxy object to easily print
std::vector<uint32_t> and spv_binary_t values.

Add a few unit tests for !<integer>. More to come.

Start using GMock: modify CMakeLists, fix googletest URL in readme.

Add useful utilities to the TestFixture class.  Also make it conform to
go/gunit recommendations about setup/teardown.

Add bin-to-text test for operand with operands

Add binary-to-text test for single instruction

This is easier to debug!

Binary-to-text testing needs more tests, and more
specific tests.  That's for future work.

Getting the next word respects quoting and escaping.

Use double quotes (").  They can be interspersed with
other whitespace characters, just like shell quoting.

A backslash (\) always escapes the next character.

The end of the stream always terminates the word.

Add AutoText struct to unit test utilities, to easily
make spv_text_t values and reference them as spv_text values.

Had spriv-tools stay inside it's own directory.

In order to facilitate having a project depend on spirv-tools,
have spirv-tools not pollute any external builds.

Move ImmediateInt tests into their own file.

This is in preparation of adding many more tests in accordance with the
evolved spec.

Also sort the test-source lines in CMakeLists.

Warn about !<integer> opcode in assignment format.

Put test classes in anonymous namespace.

Put TestFixture.h classes in a namespace.

Remove unused #includes.

Clarify !<integer> behaviour in readme.md.

Getting the next word ends at a comment (;)

Combine parsing of ID and RESULT_ID operand types

String literals must be quoted.

Fix some bugs in parsing literals.

- a single hyphen is a string, not a number.
- a string with more than one period is a string, not a number
- check for string overflow

Add some unit tests

Add SPV_FAILED_MATCH status code

This is for future use by the parser.

Add enum values for instructions added after Rev31

Add GLSL std450 extended instruction 72-80.

Add std450 instructions 53-64.

Add GLSL std450 extended instruction 65-71.