mongodb-win32-i386-1.2.1

/** @file jsobj.h BSON classes */ /* Copyright 2009 10gen Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** BSONObj and its helpers "BSON" stands for "binary JSON" -- ie a binary way to represent objects that would be represented in JSON (plus a few extensions useful for databases & other languages). http://www.mongodb.org/display/DOCS/BSON */ #pragma once #include "../stdafx.h" #include "../util/builder.h" #include "../util/optime.h" #include "boost/utility.hpp" #include <set> namespace mongo { class BSONObj; struct BSONArray; // empty subclass of BSONObj useful for overloading class BSONElement; class Record; class BSONObjBuilder; class BSONArrayBuilder; class BSONObjBuilderValueStream; #pragma pack(1) /** the complete list of valid BSON types */ enum BSONType { /** smaller than all other types */ MinKey=-1, /** end of object */ EOO=0, /** double precision floating point value */ NumberDouble=1, /** character string, stored in utf8 */ String=2, /** an embedded object */ Object=3, /** an embedded array */ Array=4, /** binary data */ BinData=5, /** Undefined type */ Undefined=6, /** ObjectId */ jstOID=7, /** boolean type */ Bool=8, /** date type */ Date=9, /** null type */ jstNULL=10, /** regular expression, a pattern with options */ RegEx=11, /** deprecated / will be redesigned */ DBRef=12, /** deprecated / use CodeWScope */ Code=13, /** a programming language (e.g., Python) symbol */ Symbol=14, /** javascript code that can execute on the database server, with SavedContext */ CodeWScope=15, /** 32 bit signed integer */ NumberInt = 16, /** Updated to a Date with value next OpTime on insert */ Timestamp = 17, /** 64 bit integer */ NumberLong = 18, /** max type that is not MaxKey */ JSTypeMax=18, /** larger than all other types */ MaxKey=127 }; /* subtypes of BinData. bdtCustom and above are ones that the JS compiler understands, but are opaque to the database. */ enum BinDataType { Function=1, ByteArray=2, bdtUUID = 3, MD5Type=5, bdtCustom=128 }; /** Object ID type. BSON objects typically have an _id field for the object id. This field should be the first member of the object when present. class OID is a special type that is a 12 byte id which is likely to be unique to the system. You may also use other types for _id's. When _id field is missing from a BSON object, on an insert the database may insert one automatically in certain circumstances. Warning: You must call OID::newState() after a fork(). */ class OID { union { struct{ long long a; unsigned b; }; unsigned char data[12]; }; static unsigned _machine; public: /** call this after a fork */ static void newState(); /** initialize to 'null' */ void clear() { a = 0; b = 0; } const unsigned char *getData() const { return data; } bool operator==(const OID& r) { return a==r.a&&b==r.b; } bool operator!=(const OID& r) { return a!=r.a||b!=r.b; } /** The object ID output as 24 hex digits. */ string str() const { stringstream s; s << hex; // s.fill( '0' ); // s.width( 2 ); // fill wasn't working so doing manually... for( int i = 0; i < 8; i++ ) { unsigned u = data[i]; if( u < 16 ) s << '0'; s << u; } const unsigned char * raw = (const unsigned char*)&b; for( int i = 0; i < 4; i++ ) { unsigned u = raw[i]; if( u < 16 ) s << '0'; s << u; } /* s.width( 16 ); s << a; s.width( 8 ); s << b; s << dec; */ return s.str(); } /** sets the contents to a new oid / randomized value */ void init(); /** Set to the hex string value specified. */ void init( string s ); }; ostream& operator<<( ostream &s, const OID &o ); /** Formatting mode for generating JSON from BSON. See <http://mongodb.onconfluence.com/display/DOCS/Mongo+Extended+JSON> for details. */ enum JsonStringFormat { /** strict RFC format */ Strict, /** 10gen format, which is close to JS format. This form is understandable by javascript running inside the Mongo server via eval() */ TenGen, /** Javascript JSON compatible */ JS }; /* l and r MUST have same type when called: check that first. */ int compareElementValues(const BSONElement& l, const BSONElement& r); #pragma pack() /* internals <type><fieldName ><value> -------- size() ------------ -fieldNameSize- value() type() */ /** BSONElement represents an "element" in a BSONObj. So for the object { a : 3, b : "abc" }, 'a : 3' is the first element (key+value). The BSONElement object points into the BSONObj's data. Thus the BSONObj must stay in scope for the life of the BSONElement. */ class BSONElement { friend class BSONObjIterator; friend class BSONObj; public: string toString( bool includeFieldName = true ) const; operator string() const { return toString(); } string jsonString( JsonStringFormat format, bool includeFieldNames = true ) const; /** Returns the type of the element */ BSONType type() const { return (BSONType) *data; } /** returns the tyoe of the element fixed for the main type the main purpose is numbers. any numeric type will return NumberDouble Note: if the order changes, indexes have to be re-built or than can be corruption */ int canonicalType() const { BSONType t = type(); switch ( t ){ case MinKey: case MaxKey: return t; case EOO: case Undefined: return 0; case jstNULL: return 5; case NumberDouble: case NumberInt: case NumberLong: return 10; case String: case Symbol: return 15; case Object: return 20; case Array: return 25; case BinData: return 30; case jstOID: return 35; case Bool: return 40; case Date: case Timestamp: return 45; case RegEx: return 50; case DBRef: return 55; case Code: return 60;