navigation.hpp

// Copyright (c) 2000-2023 TeamDev Ltd. All rights reserved.
// TeamDev PROPRIETARY and CONFIDENTIAL.
// Use is subject to license terms.
 
#ifndef MOLYBDEN_NAVIGATION_HPP
#define MOLYBDEN_NAVIGATION_HPP
 
#include <memory>
#include <string>
#include <vector>
 
#include "molybden/browser/browser.hpp"
#include "molybden/navigation/navigation_delegates.hpp"
#include "molybden/navigation/navigation_events.hpp"
#include "molybden/network/http_header.hpp"
#include "molybden/network/upload_data.hpp"
#include "molybden/time/timestamp.hpp"
 
namespace molybden {
 
constexpr int64_t kDefaultNavigationTimeoutInSeconds = 30;
 
struct LoadUrlOptions {
  std::shared_ptr<UploadData> upload_data;
 
  std::vector<HttpHeader> extra_http_headers;
};
 
enum class PageType { kUnspecified, kNormal, kError };
 
struct NavigationEntry {
  std::string title;
 
  std::string url;
 
  std::string original_request_url;
 
  HttpStatusCode http_status_code;
 
  PageType page_type;
 
  Timestamp timestamp;
};
 
class NavigationResult {
 public:
  bool hasNavigationTimedOut() const;
 
  bool operator==(NetError error) const;
 
  operator NetError() const;
 
  operator bool() const;
 
 private:
  bool operator==(const NavigationResult& result) = delete;
  explicit NavigationResult(NetError error, bool timed_out = false);
 
  bool timed_out_;
  NetError error_;
 
  friend class NavigationImpl;
};
 
class Navigation : public NavigationEvents, public NavigationDelegates {
 public:
  virtual std::shared_ptr<Browser> browser() = 0;
 
  virtual void loadUrl(const std::string& url) = 0;
 
  virtual void loadUrl(const std::string& url,
                       const LoadUrlOptions& options) = 0;
 
  virtual NavigationResult loadUrlAndWait(const std::string& url) = 0;
 
  virtual NavigationResult loadUrlAndWait(const std::string& url,
                                          uint64_t timeout_in_seconds) = 0;
 
  virtual NavigationResult loadUrlAndWait(const std::string& url,
                                          const LoadUrlOptions& options) = 0;
 
  virtual NavigationResult loadUrlAndWait(const std::string& url,
                                          const LoadUrlOptions& options,
                                          uint64_t timeout_in_seconds) = 0;
 
  virtual void goBack() = 0;
 
  virtual bool canGoBack() = 0;
 
  virtual void goForward() = 0;
 
  virtual bool canGoForward() = 0;
 
  virtual void stop() = 0;
 
  virtual void reload() = 0;
 
  virtual void reloadAndCheckForRepost() = 0;
 
  virtual void reloadIgnoringCache() = 0;
 
  virtual void reloadIgnoringCacheAndCheckForRepost() = 0;
 
  virtual void goToIndex(uint32_t index) = 0;
 
  virtual uint32_t entryCount() = 0;
 
  virtual int32_t currentEntryIndex() = 0;
 
  virtual NavigationEntry entryAtIndex(uint32_t index) = 0;
 
  virtual bool removeEntryAtIndex(uint32_t index) = 0;
};
 
}  // namespace molybden
 
#endif  // MOLYBDEN_NAVIGATION_HPP