Make the check and panic functions into macros

This allows message construction to be entirely elided in release builds
if desired.

Author: danakj

.clang-format

@@ -4,13 +4,14 @@ AllowShortCaseLabelsOnASingleLine: true
 DerivePointerAlignment: false
 PointerAlignment: Left
 ReflowComments: false
+IndentPPDirectives: AfterHash
 
 # This would be nice but it also changes requires() and not wrapping requires clauses with () introduces clang-tidy bugs like:
 #```
 #  template <size_t I>
 #    requires I <= sizeof
 #  ...(Ts) constexpr inline const auto& at() const& noexcept {
-#    ::sus::check(!moved_from(I));
+#    sus_check(!moved_from(I));
 #    return __private::find_storage<I>(storage_).value;
 #  }
 #```

STYLE.md

@@ -7,7 +7,7 @@ footguns, crashes, bugs, and UB.
 1. All methods are `constexpr` unless they must call a non-`constexpr` function,
    or they expose floating point NaNs (since constexpr NaNs change their bit
    values).
-    * Consider `panic()`/`check()` as constexpr for these purposes, they will
+    * Consider `sus_panic()`/`sus_check()` as constexpr for these purposes, they will
       correctly prevent compiling if the condition fails.
 1. If you override on `const&`, then explicitly provide or delete the `&&`
    override.

USAGE.md

@@ -39,7 +39,7 @@ target_link_libraries(subspace-example PRIVATE subspace::lib)
 int main() {
   i32 a = 6;
   i32 b = 9;
-  sus::check(a < b);
+  sus_check(a < b);
   return 0;
 }
 ```

subdoc/lib/database.h

@@ -83,7 +83,7 @@ struct CommentElement {
         name(sus::move(name)),
         sort_key(sort_key) {
     // All elements have the Global namespace in their path.
-    sus::check(this->namespace_path.len() > 0u);
+    sus_check(this->namespace_path.len() > 0u);
   }
 
   sus::Vec<Namespace> namespace_path;

subdoc/lib/friendly_names.h

@@ -67,7 +67,7 @@ inline std::string friendly_record_type_name(RecordType t,
     case RecordType::Struct: return capitalize ? "Struct" : "struct";
     case RecordType::Union: return capitalize ? "Union" : "union";
   }
-  sus::unreachable_unchecked(unsafe_fn);
+  sus_unreachable_unchecked(unsafe_fn);
 }
 
 }  // namespace subdoc

subdoc/lib/gen/files.h

@@ -99,7 +99,7 @@ inline std::filesystem::path construct_html_namespace_file_path(
         return fmt::format("namespace.{}",
                            namespace_path[0u].as<Namespace::Tag::Named>());
     }
-    sus::unreachable();
+    sus_unreachable();
   }();
 
   fname << name;
@@ -231,7 +231,7 @@ inline std::filesystem::path construct_html_file_path_for_function(
 
 inline std::string construct_html_url_anchor_for_method(
     const FunctionElement& element) noexcept {
-  sus::check(!element.record_path.is_empty());
+  sus_check(!element.record_path.is_empty());
   // There's no escaping that happens for anchors on the record page, unlike
   // for file paths. So we don't use construct_html_file_path_for_function()
   // here which escapes.
@@ -286,7 +286,7 @@ inline sus::Option<std::string> construct_html_url_for_alias(
           switch (ref) {
             case TypeRef::Tag::Record: {
               const RecordElement& e = ref.as<TypeRef::Tag::Record>();
-              sus::check_with_message(
+              sus_check_with_message(
                   !e.hidden(),
                   fmt::format("reference to hidden Record {}", e.name));
               return construct_html_url_for_type(e);
@@ -297,7 +297,7 @@ inline sus::Option<std::string> construct_html_url_for_alias(
               // aliases.
               break;
           }
-          sus::unreachable();
+          sus_unreachable();
         });
       }
       case AliasTarget::Tag::AliasOfConcept: {
@@ -311,11 +311,11 @@ inline sus::Option<std::string> construct_html_url_for_alias(
           }
           case ConceptRefOrName::Tag::Name: return sus::none();
         }
-        sus::unreachable();
+        sus_unreachable();
       }
       case AliasTarget::Tag::AliasOfMethod: {
         // TODO: Link to method.
-        sus::unreachable();
+        sus_unreachable();
       }
       case AliasTarget::Tag::AliasOfFunction: {
         const LinkedFunction& fun =
@@ -328,11 +328,11 @@ inline sus::Option<std::string> construct_html_url_for_alias(
           }
           case FunctionRefOrName::Tag::Name: return sus::none();
         }
-        sus::unreachable();
+        sus_unreachable();
       }
       case AliasTarget::Tag::AliasOfEnumConstant: {
         // TODO: Link to constant.
-        sus::unreachable();
+        sus_unreachable();
       }
       case AliasTarget::Tag::AliasOfVariable: {
         const LinkedVariable& var =
@@ -345,10 +345,10 @@ inline sus::Option<std::string> construct_html_url_for_alias(
           }
           case VariableRefOrName::Tag::Name: return sus::none();
         }
-        sus::unreachable();
+        sus_unreachable();
       }
     }
-    sus::unreachable();
+    sus_unreachable();
   } else {
     // TODO: Link to the alias' page.
     return sus::some("TODO");

subdoc/lib/gen/generate.h

@@ -70,7 +70,7 @@ struct sus::error::ErrorImpl<subdoc::gen::GenerateError> {
         return fmt::format("parsing doc comment markdown");
       }
     }
-    sus::unreachable();
+    sus_unreachable();
   }
   static sus::Option<const sus::error::DynError&> source(
       const GenerateError& e) noexcept {
@@ -88,6 +88,6 @@ struct sus::error::ErrorImpl<subdoc::gen::GenerateError> {
         return sus::some(*p);
       }
     }
-    sus::unreachable();
+    sus_unreachable();
   }
 };

subdoc/lib/gen/generate_alias.cc

@@ -116,7 +116,7 @@ sus::Result<void, MarkdownToHtmlError> generate_alias_reference(
         }
         case AliasTarget::Tag::AliasOfMethod: {
           // TODO: Link to method.
-          sus::unreachable();
+          sus_unreachable();
         }
         case AliasTarget::Tag::AliasOfFunction: {
           const LinkedFunction& fun =
@@ -132,7 +132,7 @@ sus::Result<void, MarkdownToHtmlError> generate_alias_reference(
         }
         case AliasTarget::Tag::AliasOfEnumConstant: {
           // TODO: Link to constant.
-          sus::unreachable();
+          sus_unreachable();
         }
         case AliasTarget::Tag::AliasOfVariable: {
           const LinkedVariable& var =

subdoc/lib/gen/generate_concept.cc

@@ -73,7 +73,7 @@ void generate_concept_overview(HtmlWriter::OpenDiv& record_div,
               break;  // Function can't be an ancesor of a concept.
             case CppPathConcept: return "concept-name";
           }
-          sus::unreachable();
+          sus_unreachable();
         }());
         ancestor_anchor.add_href(e.link_href);
         ancestor_anchor.write_text(e.name);

subdoc/lib/gen/generate_cpp_path.cc

@@ -41,7 +41,7 @@ sus::Vec<CppPathElement> generate_with_ancestors(
                   return std::string("(anonymous)");
                 case Namespace::Tag::Named: return sus::clone(ancestor.name);
               }
-              sus::unreachable();
+              sus_unreachable();
             }(),
         .link_href = construct_html_url_for_namespace(ancestor),
         .type =
@@ -51,7 +51,7 @@ sus::Vec<CppPathElement> generate_with_ancestors(
                 case Namespace::Tag::Anonymous: return CppPathNamespace;
                 case Namespace::Tag::Named: return CppPathNamespace;
               }
-              sus::unreachable();
+              sus_unreachable();
             }(),
     });
   }