about summary refs log tree commit diff stats
path: root/001help.cc
diff options
context:
space:
mode:
authorKartik K. Agaram <vc@akkartik.com>2015-10-29 16:47:49 -0700
committerKartik K. Agaram <vc@akkartik.com>2015-10-29 16:47:49 -0700
commit5a702544a6f8aa3fa520ba387a6c0e803e076476 (patch)
tree2825baa914bfb081bfeef891e4813a495e58b615 /001help.cc
parentf8badcdc0ce3b6d7dba5932f85f4bc529bcab128 (diff)
downloadmu-5a702544a6f8aa3fa520ba387a6c0e803e076476.tar.gz
2320
Diffstat (limited to '001help.cc')
-rw-r--r--001help.cc102
1 files changed, 51 insertions, 51 deletions
diff --git a/001help.cc b/001help.cc
index 0625639d..da3b2b75 100644
--- a/001help.cc
+++ b/001help.cc
@@ -34,59 +34,59 @@ bool is_equal(char* s, const char* lit) {
   return strncmp(s, lit, strlen(lit)) == 0;
 }
 
-// I'll throw some style conventions here for want of a better place for them.
-// As a rule I hate style guides. Do what you want, that's my motto. But since
-// we're dealing with C/C++, the one big thing we want to avoid is undefined
-// behavior. If a compiler ever encounters undefined behavior it can make
-// your program do anything it wants.
-//
-// For reference, my checklist of undefined behaviors to watch out for:
-//   out-of-bounds access
-//   uninitialized variables
-//   use after free
-//   dereferencing invalid pointers: null, a new of size 0, others
-//
-//   casting a large number to a type too small to hold it
-//
-//   integer overflow
-//   division by zero and other undefined expressions
-//   left-shift by negative count
-//   shifting values by more than or equal to the number of bits they contain
-//   bitwise operations on signed numbers
-//
-//   Converting pointers to types of different alignment requirements
-//     T* -> void* -> T*: defined
-//     T* -> U* -> T*: defined if non-function pointers and alignment requirements are same
-//     function pointers may be cast to other function pointers
-//
-//       Casting a numeric value into a value that can't be represented by the target type (either directly or via static_cast)
-//
-// To guard against these, some conventions:
-//
-// 0. Initialize all primitive variables in functions and constructors.
-//
-// 1. Minimize use of pointers and pointer arithmetic. Avoid 'new' and
-// 'delete' as far as possible. Rely on STL to perform memory management to
-// avoid use-after-free issues (and memory leaks).
-//
-// 2. Avoid naked arrays to avoid out-of-bounds access. Never use operator[]
-// except with map. Use at() with STL vectors and so on.
-//
-// 3. Valgrind all the things.
-//
-// 4. Avoid unsigned numbers. Not strictly an undefined-behavior issue, but
-// the extra range doesn't matter, and it's one less confusing category of
-// interaction gotchas to worry about.
-//
-// Corollary: don't use the size() method on containers, since it returns an
-// unsigned and that'll cause warnings about mixing signed and unsigned,
-// yadda-yadda. Instead use this macro below to perform an unsafe cast to
-// signed. We'll just give up immediately if a container's ever too large.
+//: I'll throw some style conventions here for want of a better place for them.
+//: As a rule I hate style guides. Do what you want, that's my motto. But since
+//: we're dealing with C/C++, the one big thing we want to avoid is undefined
+//: behavior. If a compiler ever encounters undefined behavior it can make
+//: your program do anything it wants.
+//:
+//: For reference, my checklist of undefined behaviors to watch out for:
+//:   out-of-bounds access
+//:   uninitialized variables
+//:   use after free
+//:   dereferencing invalid pointers: null, a new of size 0, others
+//:
+//:   casting a large number to a type too small to hold it
+//:
+//:   integer overflow
+//:   division by zero and other undefined expressions
+//:   left-shift by negative count
+//:   shifting values by more than or equal to the number of bits they contain
+//:   bitwise operations on signed numbers
+//:
+//:   Converting pointers to types of different alignment requirements
+//:     T* -> void* -> T*: defined
+//:     T* -> U* -> T*: defined if non-function pointers and alignment requirements are same
+//:     function pointers may be cast to other function pointers
+//:
+//:       Casting a numeric value into a value that can't be represented by the target type (either directly or via static_cast)
+//:
+//: To guard against these, some conventions:
+//:
+//: 0. Initialize all primitive variables in functions and constructors.
+//:
+//: 1. Minimize use of pointers and pointer arithmetic. Avoid 'new' and
+//: 'delete' as far as possible. Rely on STL to perform memory management to
+//: avoid use-after-free issues (and memory leaks).
+//:
+//: 2. Avoid naked arrays to avoid out-of-bounds access. Never use operator[]
+//: except with map. Use at() with STL vectors and so on.
+//:
+//: 3. Valgrind all the things.
+//:
+//: 4. Avoid unsigned numbers. Not strictly an undefined-behavior issue, but
+//: the extra range doesn't matter, and it's one less confusing category of
+//: interaction gotchas to worry about.
+//:
+//: Corollary: don't use the size() method on containers, since it returns an
+//: unsigned and that'll cause warnings about mixing signed and unsigned,
+//: yadda-yadda. Instead use this macro below to perform an unsafe cast to
+//: signed. We'll just give up immediately if a container's ever too large.
 :(before "End Includes")
 #define SIZE(X) (assert((X).size() < (1LL<<(sizeof(long long int)*8-2))), static_cast<long long int>((X).size()))
-//
-// 5. Integer overflow is still impossible to guard against. Maybe after
-// reading http://www.cs.utah.edu/~regehr/papers/overflow12.pdf
+//:
+//: 5. Integer overflow is still impossible to guard against. Maybe after
+//: reading http://www.cs.utah.edu/~regehr/papers/overflow12.pdf
 
 :(before "End Includes")
 #include<assert.h>