bmqt_uri.h

Go to the documentation of this file.

// Copyright 2014-2023 Bloomberg Finance L.P.
// SPDX-License-Identifier: Apache-2.0
//
// 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.
 
// bmqt_uri.h                                                         -*-C++-*-
#ifndef INCLUDED_BMQT_URI
#define INCLUDED_BMQT_URI
 
 
// BMQ
 
// BDE
#include <ball_log.h>
#include <bsl_cstddef.h>
#include <bsl_iosfwd.h>
#include <bsl_string.h>
#include <bslh_hash.h>
#include <bslma_usesbslmaallocator.h>
#include <bslmf_nestedtraitdeclaration.h>
 
namespace BloombergLP {
 
// FORWARD DECLARATION
namespace bmqt {
class UriBuilder;
}
namespace bmqt {
struct UriParser;
}
 
namespace bmqt {
 
// =========
// class Uri
// =========
 
class Uri {
  public:
    // PUBLIC CONSTANTS
 
    static const int k_QUEUENAME_MAX_LENGTH = 64;
 
  private:
    // CLASS-SCOPE CATEGORY
    BALL_LOG_SET_CLASS_CATEGORY("BMQT.URI");
 
  private:
    // FRIENDS
    friend struct UriParser;
    friend class UriBuilder;
    template <class HASH_ALGORITHM>
    friend void hashAppend(HASH_ALGORITHM& hashAlgo, const Uri& uri);
 
  private:
    // DATA
 
    bsl::string d_uri;
 
    bslstl::StringRef d_scheme;
 
    bslstl::StringRef d_authority;
 
    bslstl::StringRef d_domain;
 
    bslstl::StringRef d_tier;
 
    bslstl::StringRef d_path;
 
    bslstl::StringRef d_query_id;
 
    bool d_wasParserInitialized;
 
  private:
    // PRIVATE MANIPULATORS
 
    void reset();
 
    void copyImpl(const Uri& src);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(Uri, bslma::UsesBslmaAllocator)
 
    // CREATORS
 
    
    explicit Uri(bslma::Allocator* allocator = 0);
 
    Uri(const Uri&        original,
        bslma::Allocator* allocator = 0);  // IMPLICIT
 
    Uri(const bsl::string& uri,
        bslma::Allocator*  allocator = 0);  // IMPLICIT
    Uri(const bslstl::StringRef& uri,
        bslma::Allocator*        allocator = 0);  // IMPLICIT
    Uri(const char*       uri,
        bslma::Allocator* allocator = 0);  // IMPLICIT
 
    ~Uri();
 
    // MANIPULATORS
 
    Uri& operator=(const Uri& rhs);
 
    // ACCESSORS
 
    const bsl::string& asString() const;
 
    bool isValid() const;
 
    bool isCanonical() const;
 
    const bslstl::StringRef& scheme() const;
    const bslstl::StringRef& authority() const;
 
    const bslstl::StringRef& path() const;
 
    const bslstl::StringRef& qualifiedDomain() const;
    const bslstl::StringRef& domain() const;
    const bslstl::StringRef& tier() const;
    const bslstl::StringRef& queue() const;
 
    const bslstl::StringRef& id() const;
 
    bslstl::StringRef canonical() const;
 
    bsl::ostream&
    print(bsl::ostream& stream, int level = 0, int spacesPerLevel = 4) const;
};
 
// FREE OPERATORS
 
bool operator==(const Uri& lhs, const Uri& rhs);
 
bool operator!=(const Uri& lhs, const Uri& rhs);
 
bool operator<(const Uri& lhs, const Uri& rhs);
 
bsl::ostream& operator<<(bsl::ostream& stream, const Uri& rhs);
 
// ================
// struct UriParser
// ================
 
struct UriParser {
    // CLASS METHODS
 
    static void initialize(bslma::Allocator* allocator = 0);
 
    static void shutdown();
 
    static int parse(Uri*                     result,
                     bsl::string*             errorDescription,
                     const bslstl::StringRef& uriString);
 
  private:
    // CLASS-SCOPE CATEGORY
    BALL_LOG_SET_CLASS_CATEGORY("BMQT.URI");
};
 
// ================
// class UriBuilder
// ================
 
class UriBuilder {
  private:
    // DATA
    Uri d_uri;  // Placeholder object for URI object being built.
 
  private:
    // NOT IMPLEMENTED
 
    UriBuilder(const UriBuilder&);
    UriBuilder& operator=(const UriBuilder&);
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(UriBuilder, bslma::UsesBslmaAllocator)
 
    // CREATORS
 
    
    explicit UriBuilder(bslma::Allocator* allocator = 0);
 
    explicit UriBuilder(const bmqt::Uri& uri, bslma::Allocator* allocator = 0);
 
    // MANIPULATORS
    UriBuilder& setDomain(const bslstl::StringRef& value);
    UriBuilder& setTier(const bslstl::StringRef& value);
    UriBuilder& setQualifiedDomain(const bslstl::StringRef& value);
    UriBuilder& setQueue(const bslstl::StringRef& value);
 
    UriBuilder& setId(const bslstl::StringRef& value);
 
    void reset();
 
    // ACCESSORS
 
    int uri(Uri* result, bsl::string* errorDescription = 0) const;
};
 
// ============================================================================
//                             INLINE DEFINITIONS
// ============================================================================
 
// ---------
// class Uri
// ---------
 
inline Uri& Uri::operator=(const Uri& rhs)
{
    copyImpl(rhs);
 
    return *this;
}
 
inline const bsl::string& Uri::asString() const
{
    return d_uri;
}
 
inline bool Uri::isValid() const
{
    // URI can only be set using either 'UriBuilder' or 'UriParser', which are
    // resetting the d_uri on failure.
    return !d_uri.empty();
}
 
inline bool Uri::isCanonical() const
{
    return d_query_id.isEmpty();
}
 
inline const bslstl::StringRef& Uri::scheme() const
{
    return d_scheme;
}
 
inline const bslstl::StringRef& Uri::authority() const
{
    return d_authority;
}
 
inline const bslstl::StringRef& Uri::path() const
{
    return d_path;
}
 
inline const bslstl::StringRef& Uri::domain() const
{
    return d_domain;
}
 
inline const bslstl::StringRef& Uri::qualifiedDomain() const
{
    return d_authority;
}
 
inline const bslstl::StringRef& Uri::tier() const
{
    return d_tier;
}
 
inline const bslstl::StringRef& Uri::queue() const
{
    return d_path;
}
 
inline const bslstl::StringRef& Uri::id() const
{
    return d_query_id;
}
 
inline bslstl::StringRef Uri::canonical() const
{
    size_t queryBeginPos = d_uri.find_first_of('?');
    if (bsl::string::npos == queryBeginPos) {
        return d_uri;  // RETURN
    }
 
    return bslstl::StringRef(d_uri.c_str(), queryBeginPos);
}
 
// FREE FUNCTIONS
template <class HASH_ALGORITHM>
void hashAppend(HASH_ALGORITHM& hashAlgo, const Uri& uri)
{
    using bslh::hashAppend;           // for ADL
    hashAppend(hashAlgo, uri.d_uri);  // hashes full uri string
}
 
// ----------------
// class UriBuilder
// ----------------
 
inline UriBuilder& UriBuilder::setDomain(const bslstl::StringRef& value)
{
    d_uri.d_domain = value;
    return *this;
}
 
inline UriBuilder& UriBuilder::setTier(const bslstl::StringRef& value)
{
    d_uri.d_tier = value;
    return *this;
}
 
inline UriBuilder& UriBuilder::setQueue(const bslstl::StringRef& value)
{
    d_uri.d_path = value;
    return *this;
}
 
inline UriBuilder& UriBuilder::setId(const bslstl::StringRef& value)
{
    d_uri.d_query_id = value;
    return *this;
}
 
}  // close package namespace
 
// FREE OPERATORS
 
inline bool bmqt::operator==(const bmqt::Uri& lhs, const bmqt::Uri& rhs)
{
    return (lhs.asString() == rhs.asString());
}
 
inline bool bmqt::operator!=(const bmqt::Uri& lhs, const bmqt::Uri& rhs)
{
    return (lhs.asString() != rhs.asString());
}
 
inline bool bmqt::operator<(const bmqt::Uri& lhs, const bmqt::Uri& rhs)
{
    return (lhs.asString() < rhs.asString());
}
 
inline bsl::ostream& bmqt::operator<<(bsl::ostream&    stream,
                                      const bmqt::Uri& rhs)
{
    return rhs.print(stream, 0, -1);
}
 
}  // close enterprise namespace
 
#endif