Skip to content

Commit

Permalink
[Misc] Fix the coding style of comments in headers and tools.
Browse files Browse the repository at this point in the history 
Signed-off-by: YiYing He <[email protected]>
  • Loading branch information
@q82419 @hydai
q82419 authored and hydai committed Jan 6, 2022
1 parent 9a0249c commit 1d7deac
Show file tree
Hide file tree
Showing 45 changed files with 2,720 additions and 2,694 deletions.
4 changes: 2 additions & 2 deletions include/api/wasmedge/version.h.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
#ifndef WASMEDGE_C_API_VERSION_H
#define WASMEDGE_C_API_VERSION_H

/// WasmEdge version.
// WasmEdge version.
#define WASMEDGE_VERSION "${CPACK_PACKAGE_VERSION}"
#define WASMEDGE_VERSION_MAJOR ${WASMEDGE_VERSION_MAJOR}
#define WASMEDGE_VERSION_MINOR ${WASMEDGE_VERSION_MINOR}
#define WASMEDGE_VERSION_PATCH ${WASMEDGE_VERSION_PATCH}

#endif /// WASMEDGE_C_API_VERSION_H
#endif // WASMEDGE_C_API_VERSION_H
124 changes: 62 additions & 62 deletions include/api/wasmedge/wasmedge.h
View file

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions include/ast/instruction.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,37 +178,37 @@ class Instruction {
/// \name Data of instructions.
/// @{
union Inner {
/// Type 1: BlockType, JumpEnd, and JumpElse.
// Type 1: BlockType, JumpEnd, and JumpElse.
struct {
uint32_t JumpEnd;
uint32_t JumpElse;
BlockType ResType;
} Blocks;
/// Type 2: TargetIdx and SourceIdx.
// Type 2: TargetIdx and SourceIdx.
struct {
uint32_t TargetIdx;
uint32_t SourceIdx;
} Indices;
/// Type 3: TargetIdx and LabelList.
// Type 3: TargetIdx and LabelList.
struct {
uint32_t TargetIdx;
uint32_t LabelListSize;
uint32_t *LabelList;
} BrTable;
/// Type 4: RefType.
// Type 4: RefType.
RefType ReferenceType;
/// Type 5: ValTypeList.
// Type 5: ValTypeList.
struct {
uint32_t ValTypeListSize;
ValType *ValTypeList;
} SelectT;
/// Type 6: MemAlign, MemOffset, and MemLane.
// Type 6: MemAlign, MemOffset, and MemLane.
struct {
uint32_t MemAlign;
uint32_t MemOffset;
uint8_t MemLane;
} Memories;
/// Type 7: Num.
// Type 7: Num.
uint128_t Num;
} Data;
uint32_t Offset = 0;
Expand All @@ -220,7 +220,7 @@ class Instruction {
/// @}
};

/// Type aliasing
// Type aliasing
using InstrVec = std::vector<Instruction>;
using InstrView = Span<const Instruction>;

Expand Down
20 changes: 10 additions & 10 deletions include/common/configure.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ class CompilerConfigure {
public:
/// AOT compiler optimization level enum class.
enum class OptimizationLevel : uint8_t {
/// Disable as many optimizations as possible.
// Disable as many optimizations as possible.
O0,
/// Optimize quickly without destroying debuggability.
// Optimize quickly without destroying debuggability.
O1,
/// Optimize for fast execution as much as possible without triggering
/// significant incremental compile time or code size growth.
// Optimize for fast execution as much as possible without triggering
// significant incremental compile time or code size growth.
O2,
/// Optimize for fast execution as much as possible.
// Optimize for fast execution as much as possible.
O3,
/// Optimize for small code size as much as possible without triggering
/// significant incremental compile time or execution time slowdowns.
// Optimize for small code size as much as possible without triggering
// significant incremental compile time or execution time slowdowns.
Os,
/// Optimize for small code size as much as possible.
// Optimize for small code size as much as possible.
Oz
};
void setOptimizationLevel(OptimizationLevel Level) noexcept {
Expand All @@ -48,9 +48,9 @@ class CompilerConfigure {

/// AOT compiler output binary format.
enum class OutputFormat : uint8_t {
/// Native dynamic library format.
// Native dynamic library format.
Native,
/// WebAssembly with AOT compiled codes in custom sections.
// WebAssembly with AOT compiled codes in custom sections.
Wasm,
};
void setOutputFormat(OutputFormat Format) noexcept { OFormat = Format; }
Expand Down
64 changes: 32 additions & 32 deletions include/common/enum_ast.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
///
//===----------------------------------------------------------------------===//

/// This header is not exported to the C API.
// This header is not exported to the C API.

#ifndef WASMEDGE_C_API_ENUM_AST_H
#define WASMEDGE_C_API_ENUM_AST_H
Expand Down Expand Up @@ -90,7 +90,7 @@ static inline std::unordered_map<ASTNodeAttr, std::string> ASTNodeAttrStr = {

/// Instruction opcode enumeration class.
enum class OpCode : uint16_t {
/// Control instructions
// Control instructions
Unreachable = 0x00,
Nop = 0x01,
Block = 0x02,
Expand All @@ -105,28 +105,28 @@ enum class OpCode : uint16_t {
Call = 0x10,
Call_indirect = 0x11,

/// Reference Instructions
// Reference Instructions
Ref__null = 0xD0,
Ref__is_null = 0xD1,
Ref__func = 0xD2,

/// Parametric Instructions
// Parametric Instructions
Drop = 0x1A,
Select = 0x1B,
Select_t = 0x1C,

/// Variable Instructions
// Variable Instructions
Local__get = 0x20,
Local__set = 0x21,
Local__tee = 0x22,
Global__get = 0x23,
Global__set = 0x24,

/// Table Instructions (part 1)
// Table Instructions (part 1)
Table__get = 0x25,
Table__set = 0x26,

/// Memory Instructions (part 1)
// Memory Instructions (part 1)
I32__load = 0x28,
I64__load = 0x29,
F32__load = 0x2A,
Expand All @@ -153,13 +153,13 @@ enum class OpCode : uint16_t {
Memory__size = 0x3F,
Memory__grow = 0x40,

/// Const numeric instructions
// Const numeric instructions
I32__const = 0x41,
I64__const = 0x42,
F32__const = 0x43,
F64__const = 0x44,

/// Numeric instructions
// Numeric instructions
I32__eqz = 0x45,
I32__eq = 0x46,
I32__ne = 0x47,
Expand Down Expand Up @@ -297,21 +297,21 @@ enum class OpCode : uint16_t {
I64__trunc_sat_f64_s = 0xFC06,
I64__trunc_sat_f64_u = 0xFC07,

/// Memory Instructions (part 2)
// Memory Instructions (part 2)
Memory__init = 0xFC08,
Data__drop = 0xFC09,
Memory__copy = 0xFC0A,
Memory__fill = 0xFC0B,

/// Table Instructions (part 2)
// Table Instructions (part 2)
Table__init = 0xFC0C,
Elem__drop = 0xFC0D,
Table__copy = 0xFC0E,
Table__grow = 0xFC0F,
Table__size = 0xFC10,
Table__fill = 0xFC11,

/// SIMD Memory Instructions
// SIMD Memory Instructions
V128__load = 0xFD00,
V128__load8x8_s = 0xFD01,
V128__load8x8_u = 0xFD02,
Expand All @@ -335,13 +335,13 @@ enum class OpCode : uint16_t {
V128__store32_lane = 0xFD5A,
V128__store64_lane = 0xFD5B,

/// SIMD Const Instructions
// SIMD Const Instructions
V128__const = 0xFD0C,

/// SIMD Shuffle Instructions
// SIMD Shuffle Instructions
I8x16__shuffle = 0xFD0D,

/// SIMD Lane Instructions
// SIMD Lane Instructions
I8x16__extract_lane_s = 0xFD15,
I8x16__extract_lane_u = 0xFD16,
I8x16__replace_lane = 0xFD17,
Expand All @@ -357,7 +357,7 @@ enum class OpCode : uint16_t {
F64x2__extract_lane = 0xFD21,
F64x2__replace_lane = 0xFD22,

/// SIMD Numeric Instructions
// SIMD Numeric Instructions
I8x16__swizzle = 0xFD0E,
I8x16__splat = 0xFD0F,
I16x8__splat = 0xFD10,
Expand Down Expand Up @@ -574,7 +574,7 @@ enum class OpCode : uint16_t {

/// Instruction opcode enumeration string mapping.
static inline std::unordered_map<OpCode, std::string> OpCodeStr = {
/// Control instructions
// Control instructions
{OpCode::Unreachable, "unreachable"},
{OpCode::Nop, "nop"},
{OpCode::Block, "block"},
Expand All @@ -589,28 +589,28 @@ static inline std::unordered_map<OpCode, std::string> OpCodeStr = {
{OpCode::Call, "call"},
{OpCode::Call_indirect, "call_indirect"},

/// Reference Instructions
// Reference Instructions
{OpCode::Ref__null, "ref.null"},
{OpCode::Ref__is_null, "ref.is_null"},
{OpCode::Ref__func, "ref.func"},

/// Parametric Instructions
// Parametric Instructions
{OpCode::Drop, "drop"},
{OpCode::Select, "select"},
{OpCode::Select_t, "select"},

/// Variable Instructions
// Variable Instructions
{OpCode::Local__get, "local.get"},
{OpCode::Local__set, "local.set"},
{OpCode::Local__tee, "local.tee"},
{OpCode::Global__get, "global.get"},
{OpCode::Global__set, "global.set"},

/// Table Instructions (part 1)
// Table Instructions (part 1)
{OpCode::Table__get, "table.get"},
{OpCode::Table__set, "table.set"},

/// Memory Instructions (part 1)
// Memory Instructions (part 1)
{OpCode::I32__load, "i32.load"},
{OpCode::I64__load, "i64.load"},
{OpCode::F32__load, "f32.load"},
Expand All @@ -637,13 +637,13 @@ static inline std::unordered_map<OpCode, std::string> OpCodeStr = {
{OpCode::Memory__size, "memory.size"},
{OpCode::Memory__grow, "memory.grow"},

/// Const numeric instructions
// Const numeric instructions
{OpCode::I32__const, "i32.const"},
{OpCode::I64__const, "i64.const"},
{OpCode::F32__const, "f32.const"},
{OpCode::F64__const, "f64.const"},

/// Numeric instructions
// Numeric instructions
{OpCode::I32__eqz, "i32.eqz"},
{OpCode::I32__eq, "i32.eq"},
{OpCode::I32__ne, "i32.ne"},
Expand Down Expand Up @@ -781,21 +781,21 @@ static inline std::unordered_map<OpCode, std::string> OpCodeStr = {
{OpCode::I64__trunc_sat_f64_s, "i64.trunc_sat_f64_s"},
{OpCode::I64__trunc_sat_f64_u, "i64.trunc_sat_f64_u"},

/// Memory Instructions (part 2)
// Memory Instructions (part 2)
{OpCode::Memory__init, "memory.init"},
{OpCode::Data__drop, "data.drop"},
{OpCode::Memory__copy, "memory.copy"},
{OpCode::Memory__fill, "memory.fill"},

/// Table Instructions (part 2)
// Table Instructions (part 2)
{OpCode::Table__init, "table.init"},
{OpCode::Elem__drop, "elem.drop"},
{OpCode::Table__copy, "table.copy"},
{OpCode::Table__grow, "table.grow"},
{OpCode::Table__size, "table.size"},
{OpCode::Table__fill, "table.fill"},

/// SIMD Memory Instructions
// SIMD Memory Instructions
{OpCode::V128__load, "v128.load"},
{OpCode::V128__load8x8_s, "v128.load8x8_s"},
{OpCode::V128__load8x8_u, "v128.load8x8_u"},
Expand All @@ -819,13 +819,13 @@ static inline std::unordered_map<OpCode, std::string> OpCodeStr = {
{OpCode::V128__store32_lane, "v128.store32_lane"},
{OpCode::V128__store64_lane, "v128.store64_lane"},

/// SIMD Const Instructions
// SIMD Const Instructions
{OpCode::V128__const, "v128.const"},

/// SIMD Shuffle Instructions
// SIMD Shuffle Instructions
{OpCode::I8x16__shuffle, "i8x16.shuffle"},

/// SIMD Lane Instructions
// SIMD Lane Instructions
{OpCode::I8x16__extract_lane_s, "i8x16.extract_lane_s"},
{OpCode::I8x16__extract_lane_u, "i8x16.extract_lane_u"},
{OpCode::I8x16__replace_lane, "i8x16.replace_lane"},
Expand All @@ -841,7 +841,7 @@ static inline std::unordered_map<OpCode, std::string> OpCodeStr = {
{OpCode::F64x2__extract_lane, "f64x2.extract_lane"},
{OpCode::F64x2__replace_lane, "f64x2.replace_lane"},

/// SIMD Numeric Instructions
// SIMD Numeric Instructions
{OpCode::I8x16__swizzle, "i8x16.swizzle"},
{OpCode::I8x16__splat, "i8x16.splat"},
{OpCode::I16x8__splat, "i16x8.splat"},
Expand Down Expand Up @@ -1057,4 +1057,4 @@ static inline std::unordered_map<OpCode, std::string> OpCodeStr = {

} // namespace WasmEdge

#endif /// WASMEDGE_C_API_ENUM_AST_H
#endif // WASMEDGE_C_API_ENUM_AST_H
Loading

0 comments on commit 1d7deac

Please sign in to comment.