src/record-internal.h

   1 ///
   2 /// \file       record-internal.h
   3 ///             Support functions, types, and templates for the
   4 ///             general record parsing classes in r_*.h files.
   5 ///             This header is NOT installed for applications to
   6 ///             use, so it is safe to put library-specific things
   7 ///             in here.
   8 ///
   9
  10 /*
  11     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
  12
  13     This program is free software; you can redistribute it and/or modify
  14     it under the terms of the GNU General Public License as published by
  15     the Free Software Foundation; either version 2 of the License, or
  16     (at your option) any later version.
  17
  18     This program is distributed in the hope that it will be useful,
  19     but WITHOUT ANY WARRANTY; without even the implied warranty of
  20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  21
  22     See the GNU General Public License in the COPYING file at the
  23     root directory of this project for more details.
  24 */
  25
  26 #ifndef __BARRY_RECORD_INTERNAL_H__
  27 #define __BARRY_RECORD_INTERNAL_H__
  28
  29 #include <string>
  30 #include "protostructs.h"
  31 #include "error.h"
  32 #include "endian.h"
  33 #include "record.h"
  34
  35 // forward declarations
  36 namespace Barry { class Data; }
  37
  38 namespace Barry {
  39
  40 template <class RecordT>
  41 const unsigned char*  ParseCommonFields(RecordT &rec, const void *begin, const void *end)
  42 {
  43         const unsigned char *b = (const unsigned char*) begin;
  44         const unsigned char *e = (const unsigned char*) end;
  45
  46         while( (b + COMMON_FIELD_HEADER_SIZE) < e )
  47                 b = rec.ParseField(b, e);
  48         return b;
  49 }
  50
  51 // Use templates here to guarantee types are converted in the strictest manner.
  52 template <class SizeT>
  53 inline SizeT ConvertHtoB(SizeT s)
  54 {
  55         throw Error("Not implemented.");
  56 }
  57
  58 // specializations for specific sizes
  59 template <> inline uint8_t ConvertHtoB<uint8_t>(uint8_t s)    { return s; }
  60 template <> inline uint16_t ConvertHtoB<uint16_t>(uint16_t s) { return htobs(s); }
  61 template <> inline uint32_t ConvertHtoB<uint32_t>(uint32_t s) { return htobl(s); }
  62 template <> inline uint64_t ConvertHtoB<uint64_t>(uint64_t s) { return htobll(s); }
  63
  64
  65 template <class RecordT>
  66 struct FieldLink
  67 {
  68         int type;
  69         const char *name;
  70         const char *ldif;
  71         const char *objectClass;
  72         std::string RecordT::* strMember;       // FIXME - find a more general
  73         EmailAddress RecordT::* addrMember;     // way to do this...
  74         time_t RecordT::* timeMember;
  75         PostalAddress RecordT::* postMember;
  76         std::string PostalAddress::* postField;
  77 };
  78
  79 void BuildField1900(Data &data, size_t &size, uint8_t type, time_t t);
  80 void BuildField(Data &data, size_t &size, uint8_t type, char c);
  81 void BuildField(Data &data, size_t &size, uint8_t type, uint16_t value);
  82 void BuildField(Data &data, size_t &size, uint8_t type, const std::string &str);
  83 void BuildField(Data &data, size_t &size, uint8_t type, const void *buf, size_t bufsize);
  84 void BuildField(Data &data, size_t &size, const Barry::UnknownField &field);
  85 void BuildField(Data &data, size_t &size, uint8_t type, const Barry::Protocol::GroupLink &link);
  86 std::string ParseFieldString(const Barry::Protocol::CommonField *field);
  87 std::string ParseFieldString(const void *data, uint16_t maxlen);
  88
  89 } // namespace Barry
  90
  91 #endif
  92