Merge pull request odin-lang#5890 from odin-lang/bill/all_or_none

`struct #all_or_none`

Author: gingerBill

base/runtime/core.odin

@@ -118,10 +118,10 @@ Type_Info_Parameters :: struct { // Only used for procedures parameters and resu
 
 Type_Info_Struct_Flags :: distinct bit_set[Type_Info_Struct_Flag; u8]
 Type_Info_Struct_Flag :: enum u8 {
-	packed    = 0,
-	raw_union = 1,
-	_         = 2,
-	align     = 3,
+	packed      = 0,
+	raw_union   = 1,
+	all_or_none = 2,
+	align       = 3,
 }
 
 Type_Info_Struct :: struct {

base/runtime/print.odin

@@ -408,9 +408,9 @@ print_type :: #force_no_inline proc "contextless" (ti: ^Type_Info) {
 		}
 
 		print_string("struct ")
-		if .packed    in info.flags { print_string("#packed ") }
-		if .raw_union in info.flags { print_string("#raw_union ") }
-		// if .no_copy   in info.flags { print_string("#no_copy ") }
+		if .packed      in info.flags { print_string("#packed ") }
+		if .raw_union   in info.flags { print_string("#raw_union ") }
+		if .all_or_none in info.flags { print_string("#all_or_none ") }
 		if .align in info.flags {
 			print_string("#align(")
 			print_u64(u64(ti.align))

core/odin/ast/ast.odin

@@ -790,6 +790,7 @@ Struct_Type :: struct {
 	is_packed:       bool,
 	is_raw_union:    bool,
 	is_no_copy:      bool,
+	is_all_or_none:  bool,
 	fields:          ^Field_List,
 	name_count:      int,
 }

core/odin/doc-format/doc_format.odin

@@ -281,6 +281,7 @@ Type_Flag_Struct :: enum u32le {
 	Polymorphic = 0,
 	Packed      = 1,
 	Raw_Union   = 2,
+	All_Or_None = 3,
 }
 
 Type_Flags_Union :: distinct bit_set[Type_Flag_Union; u32le]

core/odin/parser/parser.odin

@@ -2658,11 +2658,12 @@ parse_operand :: proc(p: ^Parser, lhs: bool) -> ^ast.Expr {
 		align:           ^ast.Expr
 		min_field_align: ^ast.Expr
 		max_field_align: ^ast.Expr
-		is_packed:    bool
-		is_raw_union: bool
-		is_no_copy:   bool
-		fields:       ^ast.Field_List
-		name_count:   int
+		is_packed:       bool
+		is_raw_union:    bool
+		is_no_copy:      bool
+		is_all_or_none:  bool
+		fields:          ^ast.Field_List
+		name_count:      int
 
 		if allow_token(p, .Open_Paren) {
 			param_count: int
@@ -2684,6 +2685,11 @@ parse_operand :: proc(p: ^Parser, lhs: bool) -> ^ast.Expr {
 					error(p, tag.pos, "duplicate struct tag '#%s'", tag.text)
 				}
 				is_packed = true
+			case "all_or_none":
+				if is_all_or_none {
+					error(p, tag.pos, "duplicate struct tag '#%s'", tag.text)
+				}
+				is_all_or_none = true
 			case "align":
 				if align != nil {
 					error(p, tag.pos, "duplicate struct tag '#%s'", tag.text)
@@ -2726,6 +2732,11 @@ parse_operand :: proc(p: ^Parser, lhs: bool) -> ^ast.Expr {
 			error(p, tok.pos, "'#raw_union' cannot also be '#packed")
 		}
 
+		if is_raw_union && is_all_or_none {
+			is_all_or_none = false
+			error(p, tok.pos, "'#raw_union' cannot also be '#all_or_none")
+		}
+
 		where_token: tokenizer.Token
 		where_clauses: []^ast.Expr
 
@@ -2745,17 +2756,18 @@ parse_operand :: proc(p: ^Parser, lhs: bool) -> ^ast.Expr {
 		close := expect_closing_brace_of_field_list(p)
 
 		st := ast.new(ast.Struct_Type, tok.pos, end_pos(close))
-		st.poly_params     = poly_params
-		st.align           = align
-		st.min_field_align = min_field_align
-		st.max_field_align = max_field_align
-		st.is_packed       = is_packed
-		st.is_raw_union    = is_raw_union
-		st.is_no_copy      = is_no_copy
-		st.fields          = fields
-		st.name_count      = name_count
-		st.where_token     = where_token
-		st.where_clauses   = where_clauses
+		st.poly_params       = poly_params
+		st.align             = align
+		st.min_field_align   = min_field_align
+		st.max_field_align   = max_field_align
+		st.is_packed         = is_packed
+		st.is_raw_union      = is_raw_union
+		st.is_no_copy        = is_no_copy
+		st.is_all_or_none    = is_all_or_none
+		st.fields            = fields
+		st.name_count        = name_count
+		st.where_token       = where_token
+		st.where_clauses     = where_clauses
 		return st
 
 	case .Union:

core/reflect/types.odin

@@ -696,9 +696,9 @@ write_type_writer :: #force_no_inline proc(w: io.Writer, ti: ^Type_Info, n_writt
 		}
 
 		io.write_string(w, "struct ", &n) or_return
-		if .packed    in info.flags { io.write_string(w, "#packed ",    &n) or_return }
-		if .raw_union in info.flags { io.write_string(w, "#raw_union ", &n) or_return }
-		// if .no_copy   in info.flags { io.write_string(w, "#no_copy ", &n) or_return }
+		if .packed      in info.flags { io.write_string(w, "#packed ",    &n) or_return }
+		if .raw_union   in info.flags { io.write_string(w, "#raw_union ", &n) or_return }
+		if .all_or_none in info.flags { io.write_string(w, "#all_or_none ", &n) or_return }
 		if .align in info.flags {
 			io.write_string(w, "#align(",      &n) or_return
 			io.write_i64(w, i64(ti.align), 10, &n) or_return

src/check_expr.cpp

@@ -9838,6 +9838,51 @@ gb_internal void check_compound_literal_field_values(CheckerContext *c, Slice<As
 
 		c->bit_field_bit_size = prev_bit_field_bit_size;
 	}
+
+	if (bt->kind == Type_Struct && bt->Struct.is_all_or_none && elems.count > 0 && bt->Struct.fields.count > 0) {
+		PtrSet<Entity *> missing_fields = {};
+		defer (ptr_set_destroy(&missing_fields));
+
+		for_array(i, bt->Struct.fields) {
+			Entity *field = bt->Struct.fields[i];
+			String name = field->token.string;
+			if (is_blank_ident(name) || name == "") {
+				continue;
+			}
+			bool found = string_set_exists(&fields_visited, name);
+			String *raw_union = string_map_get(&fields_visited_through_raw_union, name);
+			if (!found && raw_union == nullptr) {
+				ptr_set_add(&missing_fields, field);
+			}
+		}
+
+		if (missing_fields.count > 0) {
+			ERROR_BLOCK();
+
+			if (build_context.terse_errors) {
+				gbString fields_string = gb_string_make(heap_allocator(), "");
+				defer (gb_string_free(fields_string));
+				isize i = 0;
+				FOR_PTR_SET(field, missing_fields) {
+					if (i > 0) {
+						fields_string = gb_string_appendc(fields_string, ", ");
+					}
+					String name = field->token.string;
+					fields_string = gb_string_append_length(fields_string, name.text, name.len);
+					i += 1;
+				}
+
+				error(o->expr, "All or none of the fields must be assigned to a struct with '#all_or_none' applied, missing fields: %s", fields_string);
+			} else {
+				error(o->expr, "All or none of the fields must be assigned to a struct with '#all_or_none' applied, missing fields:");
+				FOR_PTR_SET(field, missing_fields) {
+					gbString s = type_to_string(field->type);
+					error_line("\t%.*s: %s\n", LIT(field->token.string), s);
+					gb_string_free(s);
+				}
+			}
+		}
+	}
 }
 
 gb_internal bool is_expr_inferred_fixed_array(Ast *type_expr) {

src/check_type.cpp

@@ -654,9 +654,10 @@ gb_internal void check_struct_type(CheckerContext *ctx, Type *struct_type, Ast *
 		context = str_lit("struct #raw_union");
 	}
 
-	struct_type->Struct.node       = node;
-	struct_type->Struct.scope      = ctx->scope;
-	struct_type->Struct.is_packed  = st->is_packed;
+	struct_type->Struct.node           = node;
+	struct_type->Struct.scope          = ctx->scope;
+	struct_type->Struct.is_packed      = st->is_packed;
+	struct_type->Struct.is_all_or_none = st->is_all_or_none;
 	struct_type->Struct.polymorphic_params = check_record_polymorphic_params(
 		ctx, st->polymorphic_params,
 		&struct_type->Struct.is_polymorphic,

src/docs_format.cpp

@@ -94,6 +94,7 @@ enum OdinDocTypeFlag_Struct : u32 {
 	OdinDocTypeFlag_Struct_polymorphic = 1<<0,
 	OdinDocTypeFlag_Struct_packed      = 1<<1,
 	OdinDocTypeFlag_Struct_raw_union   = 1<<2,
+	OdinDocTypeFlag_Struct_all_or_none = 1<<3,
 };
 
 enum OdinDocTypeFlag_Union : u32 {
@@ -124,21 +125,76 @@ enum {
 
 struct OdinDocType {
 	OdinDocTypeKind kind;
+	// Type_Kind specific used by some types
+	// Underlying flag types:
+	// .Basic   - Type_Flags_Basic
+	// .Struct  - Type_Flags_Struct
+	// .Union   - Type_Flags_Union
+	// .Proc    - Type_Flags_Proc
+	// .Bit_Set - Type_Flags_Bit_Set
 	u32             flags;
+
+	// Used by:
+	// .Basic
+	// .Named
+	// .Generic
 	OdinDocString   name;
+
+	// Used By: .Struct, .Union
 	OdinDocString   custom_align;
 
-	// Used by some types
+	// Used by:
+	// .Array            - 1   count: 0=len
+	// .Enumerated_Array - 1   count: 0=len
+	// .SOA_Struct_Fixed - 1   count: 0=len
+	// .Bit_Set          - 2   count: 0=lower, 1=upper
+	// .Simd_Vector      - 1   count: 0=len
+	// .Matrix           - 2   count: 0=row_count, 1=column_count
+	// .Struct           - <=2 count: 0=min_field_align, 1=max_field_align
 	u32 elem_count_len;
 	i64 elem_counts[OdinDocType_ElemsCap];
 
-	// Each of these is esed by some types, not all
+	// Used by: .Procedures
+	// blank implies the "odin" calling convention
 	OdinDocString calling_convention;
+
+	// Used by:
+	// .Named              - 1 type:    0=base type
+	// .Generic            - <1 type:   0=specialization
+	// .Pointer            - 1 type:    0=element
+	// .Array              - 1 type:    0=element
+	// .Enumerated_Array   - 2 types:   0=index and 1=element
+	// .Slice              - 1 type:    0=element
+	// .Dynamic_Array      - 1 type:    0=element
+	// .Map                - 2 types:   0=key, 1=value
+	// .SOA_Struct_Fixed   - 1 type:    underlying SOA struct element
+	// .SOA_Struct_Slice   - 1 type:    underlying SOA struct element
+	// .SOA_Struct_Dynamic - 1 type:    underlying SOA struct element
+	// .Union              - 0+ types:  variants
+	// .Enum               - <1 type:   0=base type
+	// .Proc               - 2 types:   0=parameters, 1=results
+	// .Bit_Set            - <=2 types: 0=element type, 1=underlying type (Underlying_Type flag will be set)
+	// .Simd_Vector        - 1 type:    0=element
+	// .Relative_Pointer   - 2 types:   0=pointer type, 1=base integer
+	// .Multi_Pointer      - 1 type:    0=element
+	// .Matrix             - 1 type:    0=element
+	// .Soa_Pointer        - 1 type:    0=element
+	// .Bit_Field          - 1 type:    0=backing type
 	OdinDocArray<OdinDocTypeIndex> types;
+
+	// Used by:
+	// .Named       - 1 field for the definition
+	// .Struct      - fields
+	// .Enum        - fields
+	// .Parameters  - parameters (procedures only)
 	OdinDocArray<OdinDocEntityIndex> entities;
+
+	// Used By: .Struct, .Union
 	OdinDocTypeIndex polmorphic_params;
+	// Used By: .Struct, .Union
 	OdinDocArray<OdinDocString> where_clauses;
-	OdinDocArray<OdinDocString> tags; // struct field tags
+	// Used By: .Struct
+	OdinDocArray<OdinDocString> tags;
 };
 
 struct OdinDocAttribute {

src/docs_writer.cpp

@@ -620,6 +620,13 @@ gb_internal OdinDocTypeIndex odin_doc_type(OdinDocWriter *w, Type *type, bool ca
 			if (type->Struct.is_polymorphic) { doc_type.flags |= OdinDocTypeFlag_Struct_polymorphic; }
 			if (type->Struct.is_packed)      { doc_type.flags |= OdinDocTypeFlag_Struct_packed; }
 			if (type->Struct.is_raw_union)   { doc_type.flags |= OdinDocTypeFlag_Struct_raw_union; }
+			if (type->Struct.is_all_or_none) { doc_type.flags |= OdinDocTypeFlag_Struct_all_or_none; }
+
+			if (type->Struct.custom_min_field_align > 0 || type->Struct.custom_max_field_align > 0) {
+				doc_type.elem_count_len = 2;
+				doc_type.elem_counts[0] = cast(u32)gb_max(type->Struct.custom_min_field_align, 0);
+				doc_type.elem_counts[1] = cast(u32)gb_max(type->Struct.custom_max_field_align, 0);
+			}
 
 			auto fields = array_make<OdinDocEntityIndex>(heap_allocator(), type->Struct.fields.count);
 			defer (array_free(&fields));