Reformat Zeek in Spicy style

This largely copies over Spicy's `.clang-format` configuration file. The
one place where we deviate is header include order since Zeek depends on
headers being included in a certain order.
This commit is contained in:
Benjamin Bannier 2023-10-10 21:13:34 +02:00
parent 7b8e7ed72c
commit f5a76c1aed
786 changed files with 131714 additions and 153609 deletions

133
src/UID.h
View file

@ -7,8 +7,7 @@
#include "zeek/util.h" // for zeek_int_t
namespace zeek
{
namespace zeek {
constexpr int UID_LEN = 2;
@ -16,85 +15,79 @@ constexpr int UID_LEN = 2;
* A class for creating/managing UIDs of arbitrary bit-length and converting
* them to human-readable strings in Base62 format.
*/
class UID
{
class UID {
public:
/**
* Default ctor. The UID is uninitialized.
*/
UID() : initialized(false) { }
/**
* Default ctor. The UID is uninitialized.
*/
UID() : initialized(false) {}
/**
* Construct a UID of a given bit-length, optionally from given values.
* @see UID::Set
*/
explicit UID(zeek_uint_t bits, const uint64_t* v = nullptr, size_t n = 0) { Set(bits, v, n); }
/**
* Construct a UID of a given bit-length, optionally from given values.
* @see UID::Set
*/
explicit UID(zeek_uint_t bits, const uint64_t* v = nullptr, size_t n = 0) { Set(bits, v, n); }
/**
* Copy constructor.
*/
UID(const UID& other);
/**
* Copy constructor.
*/
UID(const UID& other);
/**
* Initialize a UID of a given bit-length, optionally from given values.
* @param bits The desired length in bits of the UID, up to a max of
* UID_LEN * 64.
* @param v A pointer to an array of values with which to initialize the
* UID. If empty or doesn't contain enough values to satisfy
* \a bits, then values are automatically generated using
* calculate_unique_id(). If \a bits isn't evenly divisible by
* 64, then a value is truncated to bit in desired bit-length.
* @param n number of 64-bit elements in array pointed to by \a v.
*/
void Set(zeek_uint_t bits, const uint64_t* v = nullptr, size_t n = 0);
/**
* Initialize a UID of a given bit-length, optionally from given values.
* @param bits The desired length in bits of the UID, up to a max of
* UID_LEN * 64.
* @param v A pointer to an array of values with which to initialize the
* UID. If empty or doesn't contain enough values to satisfy
* \a bits, then values are automatically generated using
* calculate_unique_id(). If \a bits isn't evenly divisible by
* 64, then a value is truncated to bit in desired bit-length.
* @param n number of 64-bit elements in array pointed to by \a v.
*/
void Set(zeek_uint_t bits, const uint64_t* v = nullptr, size_t n = 0);
/**
* Returns a base62 (characters 0-9, A-Z, a-z) representation of the UID.
* @param prefix An optional string prefix.
* @return a base62 string representing the UID.
*/
std::string Base62(std::string prefix = "") const;
/**
* Returns a base62 (characters 0-9, A-Z, a-z) representation of the UID.
* @param prefix An optional string prefix.
* @return a base62 string representing the UID.
*/
std::string Base62(std::string prefix = "") const;
/**
* @return false if the UID instance was created via the default ctor
* and not yet initialized w/ Set().
*/
explicit operator bool() const { return initialized; }
/**
* @return false if the UID instance was created via the default ctor
* and not yet initialized w/ Set().
*/
explicit operator bool() const { return initialized; }
/**
* Assignment operator.
*/
UID& operator=(const UID& other);
/**
* Assignment operator.
*/
UID& operator=(const UID& other);
/**
* UID equality operator.
*/
friend bool operator==(const UID& u1, const UID& u2)
{
return memcmp(u1.uid, u2.uid, sizeof(u1.uid)) == 0;
}
/**
* UID equality operator.
*/
friend bool operator==(const UID& u1, const UID& u2) { return memcmp(u1.uid, u2.uid, sizeof(u1.uid)) == 0; }
/**
* UID inequality operator.
*/
friend bool operator!=(const UID& u1, const UID& u2) { return ! (u1 == u2); }
/**
* UID inequality operator.
*/
friend bool operator!=(const UID& u1, const UID& u2) { return ! (u1 == u2); }
private:
uint64_t uid[UID_LEN];
bool initialized; // Since technically uid == 0 is a legit UID
};
uint64_t uid[UID_LEN];
bool initialized; // Since technically uid == 0 is a legit UID
};
inline UID::UID(const UID& other)
{
memcpy(uid, other.uid, sizeof(uid));
initialized = other.initialized;
}
inline UID::UID(const UID& other) {
memcpy(uid, other.uid, sizeof(uid));
initialized = other.initialized;
}
inline UID& UID::operator=(const UID& other)
{
memmove(uid, other.uid, sizeof(uid));
initialized = other.initialized;
return *this;
}
inline UID& UID::operator=(const UID& other) {
memmove(uid, other.uid, sizeof(uid));
initialized = other.initialized;
return *this;
}
} // namespace zeek
} // namespace zeek