#if !defined(RESIP_HEADERS_HXX)

#define RESIP_HEADERS_HXX 

#include "resip/stack/ParserCategories.hxx"

#include "resip/stack/HeaderTypes.hxx"

#include "resip/stack/Symbols.hxx"

#include "rutil/Data.hxx"

#include "rutil/HeapInstanceCounter.hxx"

namespace resip

{

class SipMessage;

class HeaderFieldValueList;

//#define PARTIAL_TEMPLATE_SPECIALIZATION

#ifdef PARTIAL_TEMPLATE_SPECIALIZATION

template<bool>

class TypeIf

{

   public:

      template <class T>

      class Resolve

      {

         public:

            typedef T Type;

      };

};

class UnusedHeader

{

};

class TypeIf<false>

{

   public:

      template <class T>

      class Resolve

      {

         public:

            typedef UnusedHeader Type;

      };

};

#define UnusedChecking(_enum)                                           \

      typedef TypeIf<Headers::_enum != Headers::UNKNOWN> TypeIfT;       \

      typedef TypeIfT::Resolve<Type> Resolver;                          \

      typedef Resolver::Type UnknownReturn

#define MultiUnusedChecking(_enum)                                              \

      typedef TypeIf<Headers::_enum != Headers::UNKNOWN> TypeIfT;               \

      typedef TypeIfT::Resolve< ParserContainer<Type> > Resolver;               \

      typedef Resolver::Type UnknownReturn

#else

#define UnusedChecking(_enum) typedef int _dummy

#define MultiUnusedChecking(_enum) typedef int _dummy

#endif

class HeaderBase

{

   public:

      virtual ~HeaderBase() {}

      virtual Headers::Type getTypeNum() const = 0;

      virtual void merge(SipMessage&, const SipMessage&)=0;

      static HeaderBase* getInstance(Headers::Type typenum)

      {

         return theHeaderInstances[typenum+1];

      }

      virtual ParserContainerBase* makeContainer(HeaderFieldValueList* hfvs) const=0;

   protected:

      static HeaderBase* theHeaderInstances[Headers::MAX_HEADERS+1];

};

#define defineHeader(_enum, _name, _type, _rfc)                 \

class H_##_enum : public HeaderBase                             \

{                                                               \

   public:                                                      \

      RESIP_HeapCount(H_##_enum);                               \

      enum {Single = true};                                     \

      typedef _type Type;                                       \

      UnusedChecking(_enum);                                    \

      static Type& knownReturn(ParserContainerBase* container); \

      virtual ParserContainerBase* makeContainer(HeaderFieldValueList* hfvs) const;       \

      virtual Headers::Type getTypeNum() const;                 \

      virtual void merge(SipMessage&, const SipMessage&);       \

      H_##_enum();                                              \

};                                                              \

extern H_##_enum h_##_enum

#define defineMultiHeader(_enum, _name, _type, _rfc)            \

class H_##_enum##s : public HeaderBase                          \

{                                                               \

   public:                                                      \

      RESIP_HeapCount(H_##_enum##s);                            \

      enum {Single = false};                                    \

      typedef ParserContainer<_type> Type;                      \

      typedef _type ContainedType;                      \

      MultiUnusedChecking(_enum);                               \

      static Type& knownReturn(ParserContainerBase* container); \

      virtual ParserContainerBase* makeContainer(HeaderFieldValueList* hfvs) const;       \

      virtual Headers::Type getTypeNum() const;                 \

      virtual void merge(SipMessage&, const SipMessage&);       \

      H_##_enum##s();                                           \

};                                                              \

extern H_##_enum##s h_##_enum##s

//====================

// Token:

//====================

typedef ParserContainer<Token> Tokens;

defineHeader(ContentDisposition, "Content-Disposition", Token, "RFC 3261");

defineHeader(ContentEncoding, "Content-Encoding", Token, "RFC 3261");

defineHeader(MIMEVersion, "Mime-Version", Token, "RFC 3261");

defineHeader(Priority, "Priority", Token, "RFC 3261");

defineHeader(Event, "Event", Token, "RFC 3265");

defineHeader(SubscriptionState, "Subscription-State", Token, "RFC 3265");

defineHeader(SIPETag, "SIP-ETag", Token, "RFC 3903");

defineHeader(SIPIfMatch, "SIP-If-Match", Token, "RFC 3903");

defineHeader(ContentId, "Content-ID", Token, "RFC 2045");

defineMultiHeader(Identity, "Identity", StringCategory, "RFC 8224");  // Originally defined in RFC 4474 as a single header, but later modified by RFC8224 to be a multiheader

// explicitly declare to avoid h_Identitys

extern H_Identitys h_Identities;

defineMultiHeader(AllowEvents, "Allow-Events", Token, "RFC 3265");

// explicitly declare to avoid h_AllowEventss, ugh

extern H_AllowEventss h_AllowEvents;

defineMultiHeader(AcceptEncoding, "Accept-Encoding", Token, "RFC 3261");

defineMultiHeader(AcceptLanguage, "Accept-Language", Token, "RFC 3261");

defineMultiHeader(Allow, "Allow", Token, "RFC 3261");

defineMultiHeader(ContentLanguage, "Content-Language", Token, "RFC 3261");

defineMultiHeader(ProxyRequire, "Proxy-Require", Token, "RFC 3261");

defineMultiHeader(Require, "Require", Token, "RFC 3261");

defineMultiHeader(Supported, "Supported", Token, "RFC 3261");

defineMultiHeader(Unsupported, "Unsupported", Token, "RFC 3261");

defineMultiHeader(SecurityClient, "Security-Client", Token, "RFC 3329");

defineMultiHeader(SecurityServer, "Security-Server", Token, "RFC 3329");

defineMultiHeader(SecurityVerify, "Security-Verify", Token, "RFC 3329");

// explicitly declare to avoid h_SecurityVerifys, ugh

extern H_SecurityVerifys h_SecurityVerifies;

defineMultiHeader(RequestDisposition, "Request-Disposition", Token, "RFC 3841");

defineMultiHeader(Reason, "Reason", Token, "RFC 3326");

defineMultiHeader(Privacy, "Privacy", PrivacyCategory, "RFC 3323");

// explicitly declare to avoid h_Privacys

extern H_Privacys h_Privacies;

defineMultiHeader(PMediaAuthorization, "P-Media-Authorization", Token, "RFC 3313");

defineHeader(ReferSub, "Refer-Sub", Token, "RFC 4488");

defineHeader(AnswerMode, "Answer-Mode", Token, "draft-ietf-answermode-01");

defineHeader(PrivAnswerMode, "Priv-Answer-Mode", Token, "draft-ietf-answermode-01");

defineMultiHeader(PAccessNetworkInfo, "P-Access-Network-Info", Token, "RFC 7315"); // section 5.4.

defineHeader(PChargingVector, "P-Charging-Vector", Token, "RFC 3455");

defineHeader(PChargingFunctionAddresses, "P-Charging-Function-Addresses", Token, "RFC 3455");

//====================

// Mime

//====================

typedef ParserContainer<Mime> Mimes;

defineMultiHeader(Accept, "Accept", Mime, "RFC 3261");

defineHeader(ContentType, "Content-Type", Mime, "RFC 3261");

//====================

// GenericUris:

//====================

typedef ParserContainer<GenericUri> GenericUris;

defineMultiHeader(CallInfo, "Call-Info", GenericUri, "RFC 3261");

defineMultiHeader(AlertInfo, "Alert-Info", GenericUri, "RFC 3261");

defineMultiHeader(ErrorInfo, "Error-Info", GenericUri, "RFC 3261");

defineHeader(IdentityInfo, "Identity-Info", GenericUri, "RFC 4474");      // deprecated by RFC8224

//====================

// NameAddr:

//====================

typedef ParserContainer<NameAddr> NameAddrs;

defineMultiHeader(RecordRoute, "Record-Route", NameAddr, "RFC 3261");

defineMultiHeader(Route, "Route", NameAddr, "RFC 3261");

defineMultiHeader(Contact, "Contact", NameAddr, "RFC 3261");

defineHeader(From, "From", NameAddr, "RFC 3261");

defineHeader(To, "To", NameAddr, "RFC 3261");

defineHeader(ReplyTo, "Reply-To", NameAddr, "RFC 3261");

defineHeader(ReferTo, "Refer-To", NameAddr, "RFC 3515");

defineHeader(ReferredBy, "Referred-By", NameAddr, "RFC 3892");

defineMultiHeader(Path, "Path", NameAddr, "RFC 3327");

defineMultiHeader(AcceptContact, "Accept-Contact", NameAddr, "RFC 3841");

defineMultiHeader(RejectContact, "Reject-Contact", NameAddr, "RFC 3841");

defineMultiHeader(PPreferredIdentity, "P-Preferred-Identity", NameAddr, "RFC 3325");

// explicitly declare to avoid h_PAssertedIdentitys

extern H_PPreferredIdentitys h_PPreferredIdentities;

defineMultiHeader(PAssertedIdentity, "P-Asserted-Identity", NameAddr, "RFC 3325");

// explicitly declare to avoid h_PAssertedIdentitys

extern H_PAssertedIdentitys h_PAssertedIdentities;

defineHeader(PCalledPartyId, "P-Called-Party-ID", NameAddr, "RFC 3455");

defineMultiHeader(PAssociatedUri, "P-Associated-URI", NameAddr, "RFC 3455");

defineMultiHeader(ServiceRoute, "Service-Route", NameAddr, "RFC 3608");

defineMultiHeader(RemotePartyId, "Remote-Party-ID", NameAddr, "draft-ietf-sip-privacy-04"); // ?bwc? Not in 3323, should we keep?

defineMultiHeader(HistoryInfo, "History-Info", NameAddr, "RFC 4244");

//====================

// StringCategory:

//====================

typedef ParserContainer<StringCategory> StringCategories;

defineHeader(ContentTransferEncoding, "Content-Transfer-Encoding", StringCategory, "RFC ?");

defineHeader(Organization, "Organization", StringCategory, "RFC 3261");

defineHeader(SecWebSocketKey, "Sec-WebSocket-Key", StringCategory, "RFC 6455");

defineHeader(SecWebSocketKey1, "Sec-WebSocket-Key1", StringCategory, "draft-hixie- thewebsocketprotocol-76");

defineHeader(SecWebSocketKey2, "Sec-WebSocket-Key2", StringCategory, "draft-hixie- thewebsocketprotocol-76");

defineHeader(Origin, "Origin", StringCategory, "draft-hixie- thewebsocketprotocol-76");

defineHeader(Host, "Host", StringCategory, "draft-hixie- thewebsocketprotocol-76");

defineHeader(SecWebSocketAccept, "Sec-WebSocket-Accept", StringCategory, "RFC 6455");

defineMultiHeader(Cookie, "Cookie", StringCategory, "RFC 6265");

defineHeader(Server, "Server", StringCategory, "RFC 3261");

defineHeader(Subject, "Subject", StringCategory, "RFC 3261");

defineHeader(UserAgent, "User-Agent", StringCategory, "RFC 3261");

defineHeader(Timestamp, "Timestamp", StringCategory, "RFC 3261");

//====================

// ExpiresCategory:

//====================

defineHeader(Expires, "Expires", ExpiresCategory, "RFC 3261");

defineHeader(SessionExpires, "Session-Expires", ExpiresCategory, "RFC 4028");

defineHeader(MinSE, "Min-SE", ExpiresCategory, "RFC 4028");

//====================

// UInt32Category:

//====================

typedef ParserContainer<UInt32Category> UInt32Categories;

defineHeader(MaxForwards, "Max-Forwards", UInt32Category, "RFC 3261");

// !dlb! not clear this needs to be exposed

defineHeader(ContentLength, "Content-Length", UInt32Category, "RFC 3261");

defineHeader(MinExpires, "Min-Expires", UInt32Category, "RFC 3261");

defineHeader(RSeq, "RSeq", UInt32Category, "RFC 3261");

// !dlb! this one is not quite right -- can have (comment) after field value

defineHeader(RetryAfter, "Retry-After", UInt32Category, "RFC 3261");

defineHeader(FlowTimer, "Flow-Timer", UInt32Category, "RFC 5626");

//====================

// CallId:

//====================

defineHeader(CallID, "Call-ID", CallID, "RFC 3261");

defineHeader(Replaces, "Replaces", CallID, "RFC 3891");

defineHeader(InReplyTo, "In-Reply-To", CallID, "RFC 3261");

typedef H_CallID H_CallId; // code convention compatible

extern H_CallId h_CallId; // code convention compatible

defineHeader(Join, "Join", CallId, "RFC 3911");

defineHeader(TargetDialog, "Target-Dialog", CallId, "RFC 4538");

//====================

// Auth:

//====================

typedef ParserContainer<Auth> Auths;

defineHeader(AuthenticationInfo, "Authentication-Info", Auth, "RFC 3261");

defineMultiHeader(Authorization, "Authorization", Auth, "RFC 3261");

defineMultiHeader(ProxyAuthenticate, "Proxy-Authenticate", Auth, "RFC 3261");

defineMultiHeader(ProxyAuthorization, "Proxy-Authorization", Auth, "RFC 3261");

defineMultiHeader(WWWAuthenticate, "Www-Authenticate", Auth, "RFC 3261");

//====================

// CSeqCategory:

//====================

defineHeader(CSeq, "CSeq", CSeqCategory, "RFC 3261");

//====================

// DateCategory:

//====================

defineHeader(Date, "Date", DateCategory, "RFC 3261");

//====================

// WarningCategory:

//====================

defineMultiHeader(Warning, "Warning", WarningCategory, "RFC 3261");

//Enforces string encoding of extension headers

defineMultiHeader(RESIP_DO_NOT_USE, "If you see this things are seriously awry", StringCategory, "NA");

//====================

// Via

//====================

typedef ParserContainer<Via> Vias;

defineMultiHeader(Via, "Via", Via, "RFC 3261");

//====================

// RAckCategory

//====================

defineHeader(RAck, "RAck", RAckCategory, "RFC 3262");

//============================

// TokenOrQuotedStringCategory

//============================

defineMultiHeader(PVisitedNetworkID, "P-Visited-Network-ID", TokenOrQuotedStringCategory, "RFC 3455");

defineMultiHeader(UserToUser, "User-to-User", TokenOrQuotedStringCategory, "draft-ietf-cuss-sip-uui-17");

//====================

// special first line accessors

//====================

class RequestLineType {};

extern RequestLineType h_RequestLine;

class StatusLineType {};

extern StatusLineType h_StatusLine;

}

#undef defineHeader

#undef defineMultiHeader

#endif

/* ====================================================================

 * The Vovida Software License, Version 1.0 

 * 

 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.

 * 

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 * 

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 * 

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in

 *    the documentation and/or other materials provided with the

 *    distribution.

 * 

 * 3. The names "VOCAL", "Vovida Open Communication Application Library",

 *    and "Vovida Open Communication Application Library (VOCAL)" must

 *    not be used to endorse or promote products derived from this

 *    software without prior written permission. For written

 *    permission, please contact vocal@vovida.org.

 *

 * 4. Products derived from this software may not be called "VOCAL", nor

 *    may "VOCAL" appear in their name, without prior written

 *    permission of Vovida Networks, Inc.

 * 

 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED

 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND

 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA

 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES

 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE

 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH

 * DAMAGE.

 * 

 * ====================================================================

 * 

 * This software consists of voluntary contributions made by Vovida

 * Networks, Inc. and many individuals on behalf of Vovida Networks,

 * Inc.  For more information on Vovida Networks, Inc., please see

 * <http://www.vovida.org/>.

 *

 */