URI.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * 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.
 *
*/
#ifndef IGNITION_COMMON_URI_HH_
#define IGNITION_COMMON_URI_HH_

#include <memory>
#include <optional>
#include <string>

#include <ignition/common/Export.hh>
#include <ignition/common/SuppressWarning.hh>

namespace ignition
{
  namespace common
  {
    // Forward declare private data classes.
    class URIAuthorityPrivate;
    class URIPathPrivate;
    class URIQueryPrivate;
    class URIFragmentPrivate;
    class URIPrivate;

    class IGNITION_COMMON_VISIBLE URIAuthority
    {
      public: URIAuthority();

      public: URIAuthority(const URIAuthority &_path);

      public: explicit URIAuthority(const std::string &_str);

      public: virtual ~URIAuthority();

      public: void Clear();

      public: std::string UserInfo() const;

      public: void SetUserInfo(const std::string &_userInfo) const;

      public: std::string Host() const;

      public: void SetHost(const std::string &_host) const;

      public: bool EmptyHostValid() const;

      public: void SetEmptyHostValid(bool _valid) const;

      public: std::optional<int> Port() const;

      public: void SetPort(int _port) const;

      public: bool operator==(const URIAuthority &_auth) const;

      public: std::string Str() const;

      public: URIAuthority &operator=(const URIAuthority &_auth);

      public: static bool Valid(const std::string &_str,
                  bool _emptyHostValid = false);

      public: bool Valid() const;

      public: bool Parse(const std::string &_str,
                  bool _emptyHostValid = false);

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<URIAuthorityPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };

    class IGNITION_COMMON_VISIBLE URIPath
    {
      public: URIPath();

      public: URIPath(const URIPath &_path);

      public: explicit URIPath(const std::string &_str);

      public: virtual ~URIPath();

      public: void Clear();

      public: bool IsAbsolute() const;

      public: void SetAbsolute(bool _absolute = true);

      public: void SetRelative();

      public: void PushFront(const std::string &_part);

      public: void PushBack(const std::string &_part);

      public: std::string PopFront();

      public: std::string PopBack();

      public: const URIPath &operator/=(const std::string &_part);

      public: const URIPath operator/(const std::string &_part) const;

      public: bool operator==(const URIPath &_path) const;

      public: std::string Str(const std::string &_delim = "/") const;

      public: URIPath &operator=(const URIPath &_path);

      public: static bool Valid(const std::string &_str);

      public: bool Valid() const;

      public: bool Parse(const std::string &_str);

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<URIPathPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };

    class IGNITION_COMMON_VISIBLE URIQuery
    {
      public: URIQuery();

      public: explicit URIQuery(const std::string &_str);

      public: URIQuery(const URIQuery &_query);

      public: virtual ~URIQuery();

      public: void Clear();

      public: void Insert(const std::string &_key,
                          const std::string &_value);

      public: URIQuery &operator=(const URIQuery &_query);

      public: bool operator==(const URIQuery &_query) const;

      public: std::string Str(const std::string &_delim = "&") const;

      public: static bool Valid(const std::string &_str);

      public: bool Valid() const;

      public: bool Parse(const std::string &_string);

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<URIQueryPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };

    class IGNITION_COMMON_VISIBLE URIFragment
    {
      public: URIFragment();

      public: explicit URIFragment(const std::string &_str);

      public: URIFragment(const URIFragment &_fragment);

      public: virtual ~URIFragment();

      public: void Clear();

      public: URIFragment &operator=(const URIFragment &_fragment);

      public: URIFragment &operator=(const std::string &_fragment);

      public: bool operator==(const URIFragment &_fragment) const;

      public: std::string Str() const;

      public: static bool Valid(const std::string &_str);

      public: bool Valid() const;

      public: bool Parse(const std::string &_string);

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<URIFragmentPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };

    // cppcheck-suppress class_X_Y
    class IGNITION_COMMON_VISIBLE URI
    {
      public: URI();

      public: explicit URI(const std::string &_str,
          bool _hasAuthority = false);

      public: URI(const URI &_uri);

      public: ~URI();

      public: std::string Str() const;

      public: void Clear();

      public: std::string Scheme() const;

      public: void SetScheme(const std::string &_scheme);

      public: void SetAuthority(const URIAuthority &_authority);

      public: std::optional<URIAuthority> Authority() const;

      public: URIPath &Path();

      public: const URIPath &Path() const;

      public: URIQuery &Query();

      public: const URIQuery &Query() const;

      public: URIFragment &Fragment();

      public: const URIFragment &Fragment() const;

      public: URI &operator=(const URI &_uri);

      public: bool operator==(const URI &_uri) const;

      public: bool Valid() const;

      public: static bool Valid(const std::string &_str);

      public: bool Parse(const std::string &_str);

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<URIPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
#endif