make save_state_flags a strong type

Author: arvidn

bindings/python/src/converters.cpp

@@ -15,6 +15,7 @@
 #include "libtorrent/aux_/noexcept_movable.hpp"
 #include "libtorrent/peer_info.hpp"
 #include "libtorrent/alert_types.hpp" // for picker_flags_t
+#include "libtorrent/session_types.hpp" // for save_state_flags_t
 #include "libtorrent/alert.hpp"
 #include <vector>
 
@@ -304,6 +305,9 @@ void bind_converters()
     to_python_converter<lt::add_piece_flags_t, from_bitfield_flag<lt::add_piece_flags_t>>();
     to_python_converter<lt::pause_flags_t, from_bitfield_flag<lt::pause_flags_t>>();
     to_python_converter<lt::deadline_flags_t, from_bitfield_flag<lt::deadline_flags_t>>();
+    to_python_converter<lt::save_state_flags_t, from_bitfield_flag<lt::save_state_flags_t>>();
+    to_python_converter<lt::session_flags_t, from_bitfield_flag<lt::session_flags_t>>();
+    to_python_converter<lt::remove_flags_t, from_bitfield_flag<lt::remove_flags_t>>();
 
     // work-around types
     to_python_converter<lt::aux::noexcept_movable<lt::address>, address_to_tuple<
@@ -358,4 +362,7 @@ void bind_converters()
     to_bitfield_flag<lt::add_piece_flags_t>();
     to_bitfield_flag<lt::pause_flags_t>();
     to_bitfield_flag<lt::deadline_flags_t>();
+    to_bitfield_flag<lt::save_state_flags_t>();
+    to_bitfield_flag<lt::session_flags_t>();
+    to_bitfield_flag<lt::remove_flags_t>();
 }

bindings/python/src/session.cpp

@@ -163,7 +163,7 @@ namespace
 		return ret;
 	}
 
-	std::shared_ptr<lt::session> make_session(boost::python::dict sett, int flags)
+	std::shared_ptr<lt::session> make_session(boost::python::dict sett, session_flags_t flags)
 	{
 		settings_pack p;
 		make_settings_pack(p, sett);
@@ -471,11 +471,11 @@ namespace
     }
 #endif
 
-    entry save_state(lt::session const& s, std::uint32_t flags)
+    entry save_state(lt::session const& s, std::uint32_t const flags)
     {
         allow_threading_guard guard;
         entry e;
-        s.save_state(e, flags);
+        s.save_state(e, save_state_flags_t(flags));
         return e;
     }
 
@@ -495,7 +495,7 @@ namespace
         return ret;
     }
 
-	void load_state(lt::session& ses, entry const& st, std::uint32_t flags)
+	void load_state(lt::session& ses, entry const& st, std::uint32_t const flags)
 	{
 		allow_threading_guard guard;
 
@@ -505,7 +505,7 @@ namespace
 		error_code ec;
 		bdecode(&buf[0], &buf[0] + buf.size(), e, ec);
 		TORRENT_ASSERT(!ec);
-		ses.load_state(e, flags);
+		ses.load_state(e, save_state_flags_t(flags));
 	}
 
 #ifndef TORRENT_DISABLE_DHT
@@ -564,6 +564,9 @@ struct dummy1 {};
 #ifndef TORRENT_NO_DEPRECATE
 struct dummy2 {};
 #endif
+struct dummy9 {};
+struct dummy10 {};
+struct dummy11 {};
 
 void bind_session()
 {
@@ -695,21 +698,21 @@ void bind_session()
 #endif
       ;
 
-
     enum_<storage_mode_t>("storage_mode_t")
         .value("storage_mode_allocate", storage_mode_allocate)
         .value("storage_mode_sparse", storage_mode_sparse)
     ;
 
-    enum_<lt::session::options_t>("options_t")
-        .value("delete_files", lt::session::delete_files)
-    ;
-
-    enum_<lt::session::session_flags_t>("session_flags_t")
-        .value("add_default_plugins", lt::session::add_default_plugins)
-        .value("start_default_features", lt::session::start_default_features)
-    ;
+    {
+        scope s = class_<dummy11>("options_t");
+        s.attr("delete_files") = lt::session::delete_files;
+    }
 
+    {
+        scope s = class_<dummy10>("session_flags_t");
+        s.attr("add_default_plugins") = lt::session::add_default_plugins;
+        s.attr("start_default_features") = lt::session::start_default_features;
+    }
 
     {
     scope s = class_<dummy1>("torrent_flags");
@@ -799,10 +802,10 @@ void bind_session()
         )
 #ifndef TORRENT_NO_DEPRECATE
         .def(
-            init<fingerprint, int, std::uint32_t>((
+            init<fingerprint, session_flags_t, alert_category_t>((
                 arg("fingerprint")=fingerprint("LT",0,1,0,0)
                 , arg("flags")=lt::session::start_default_features | lt::session::add_default_plugins
-                , arg("alert_mask")=int(alert::error_notification)))
+                , arg("alert_mask")=alert::error_notification))
         )
         .def("outgoing_ports", &outgoing_ports)
 #endif
@@ -933,21 +936,22 @@ void bind_session()
         .value("tcp", lt::session::tcp)
     ;
 
-    enum_<lt::session::save_state_flags_t>("save_state_flags_t")
-        .value("save_settings", lt::session::save_settings)
-        .value("save_dht_settings", lt::session::save_dht_settings)
-        .value("save_dht_state", lt::session::save_dht_state)
-        .value("save_encryption_settings", lt::session:: save_encryption_settings)
+    {
+        scope s = class_<dummy9>("save_state_flags_t");
+        s.attr("save_settings") = lt::session::save_settings;
+        s.attr("save_dht_settings") = lt::session::save_dht_settings;
+        s.attr("save_dht_state") = lt::session::save_dht_state;
+        s.attr("save_encryption_settings") = lt::session:: save_encryption_settings;
 #ifndef TORRENT_NO_DEPRECATE
-        .value("save_as_map", lt::session::save_as_map)
-        .value("save_i2p_proxy", lt::session::save_i2p_proxy)
-        .value("save_proxy", lt::session::save_proxy)
-        .value("save_dht_proxy", lt::session::save_dht_proxy)
-        .value("save_peer_proxy", lt::session::save_peer_proxy)
-        .value("save_web_proxy", lt::session::save_web_proxy)
-        .value("save_tracker_proxy", lt::session::save_tracker_proxy)
+        s.attr("save_as_map") = lt::session::save_as_map;
+        s.attr("save_i2p_proxy") = lt::session::save_i2p_proxy;
+        s.attr("save_proxy") = lt::session::save_proxy;
+        s.attr("save_dht_proxy") = lt::session::save_dht_proxy;
+        s.attr("save_peer_proxy") = lt::session::save_peer_proxy;
+        s.attr("save_web_proxy") = lt::session::save_web_proxy;
+        s.attr("save_tracker_proxy") = lt::session::save_tracker_proxy;
 #endif
-    ;
+    }
 
 #ifndef TORRENT_NO_DEPRECATE
     enum_<lt::session::listen_on_flags_t>("listen_on_flags_t")

docs/hunspell/libtorrent.dic

@@ -208,3 +208,6 @@ Hellman
 html
 namespace
 dn
+pe
+lt
+tex

include/libtorrent/Makefile.am

@@ -116,6 +116,7 @@ nobase_include_HEADERS = \
   session_settings.hpp         \
   session_stats.hpp            \
   session_status.hpp           \
+  session_types.hpp            \
   settings_pack.hpp            \
   sha1.hpp                     \
   sha512.hpp                   \

include/libtorrent/aux_/session_impl.hpp

@@ -499,8 +499,8 @@ namespace aux {
 			void on_async_load_torrent(add_torrent_params* params, error_code ec);
 #endif
 
-			void remove_torrent(torrent_handle const& h, int options) override;
-			void remove_torrent_impl(std::shared_ptr<torrent> tptr, int options) override;
+			void remove_torrent(torrent_handle const& h, remove_flags_t options) override;
+			void remove_torrent_impl(std::shared_ptr<torrent> tptr, remove_flags_t options) override;
 
 			void get_torrent_status(std::vector<torrent_status>* ret
 				, std::function<bool(torrent_status const&)> const& pred
@@ -600,8 +600,8 @@ namespace aux {
 
 			void announce_lsd(sha1_hash const& ih, int port, bool broadcast = false) override;
 
-			void save_state(entry* e, std::uint32_t flags) const;
-			void load_state(bdecode_node const* e, std::uint32_t flags);
+			void save_state(entry* e, save_state_flags_t flags) const;
+			void load_state(bdecode_node const* e, save_state_flags_t flags);
 
 			bool has_connection(peer_connection* p) const override;
 			void insert_peer(std::shared_ptr<peer_connection> const& c) override;

include/libtorrent/aux_/session_interface.hpp

@@ -43,6 +43,7 @@ POSSIBILITY OF SUCH DAMAGE.
 #include "libtorrent/socket.hpp" // for tcp::endpoint
 #include "libtorrent/aux_/vector.hpp"
 #include "libtorrent/aux_/listen_socket_handle.hpp"
+#include "libtorrent/session_types.hpp"
 
 #include <functional>
 #include <memory>
@@ -155,8 +156,8 @@ namespace libtorrent { namespace aux {
 		virtual bool has_connection(peer_connection* p) const = 0;
 		virtual void insert_peer(std::shared_ptr<peer_connection> const& c) = 0;
 
-		virtual void remove_torrent(torrent_handle const& h, int options = 0) = 0;
-		virtual void remove_torrent_impl(std::shared_ptr<torrent> tptr, int options) = 0;
+		virtual void remove_torrent(torrent_handle const& h, remove_flags_t options = {}) = 0;
+		virtual void remove_torrent_impl(std::shared_ptr<torrent> tptr, remove_flags_t options) = 0;
 
 		// port filter
 		virtual port_filter const& get_port_filter() const = 0;

include/libtorrent/aux_/storage_utils.hpp

@@ -40,6 +40,7 @@ POSSIBILITY OF SUCH DAMAGE.
 #include "libtorrent/aux_/typed_span.hpp"
 #include "libtorrent/units.hpp"
 #include "libtorrent/storage_defs.hpp" // for status_t
+#include "libtorrent/session_types.hpp"
 
 namespace libtorrent {
 
@@ -85,7 +86,7 @@ namespace aux {
 	// opt to only delete the partfile
 	TORRENT_EXTRA_EXPORT void
 	delete_files(file_storage const& fs, std::string const& save_path
-		, std::string const& part_file_name, int const options, storage_error& ec);
+		, std::string const& part_file_name, remove_flags_t const options, storage_error& ec);
 
 	TORRENT_EXTRA_EXPORT bool
 	verify_resume_data(add_torrent_params const& rd

include/libtorrent/disk_interface.hpp

@@ -46,6 +46,7 @@ POSSIBILITY OF SUCH DAMAGE.
 #include "libtorrent/time.hpp"
 #include "libtorrent/sha1_hash.hpp"
 #include "libtorrent/flags.hpp"
+#include "libtorrent/session_types.hpp"
 
 namespace libtorrent {
 
@@ -164,7 +165,7 @@ namespace libtorrent {
 		virtual void async_rename_file(storage_index_t storage
 			, file_index_t index, std::string name
 			, std::function<void(std::string const&, file_index_t, storage_error const&)> handler) = 0;
-		virtual void async_delete_files(storage_index_t storage, int options
+		virtual void async_delete_files(storage_index_t storage, remove_flags_t options
 			, std::function<void(storage_error const&)> handler) = 0;
 		virtual void async_set_file_priority(storage_index_t storage
 			, aux::vector<std::uint8_t, file_index_t> prio

include/libtorrent/disk_io_job.hpp

@@ -41,6 +41,7 @@ POSSIBILITY OF SUCH DAMAGE.
 #include "libtorrent/disk_interface.hpp"
 #include "libtorrent/aux_/vector.hpp"
 #include "libtorrent/units.hpp"
+#include "libtorrent/session_types.hpp"
 
 #include "libtorrent/aux_/disable_warnings_push.hpp"
 #include <boost/variant/variant.hpp>
@@ -127,7 +128,8 @@ namespace libtorrent {
 			, std::string
 			, add_torrent_params const*
 			, aux::vector<std::uint8_t, file_index_t>
-			, int> argument;
+			, remove_flags_t
+			> argument;
 
 		// the disk storage this job applies to (if applicable)
 		std::shared_ptr<storage_interface> storage;

include/libtorrent/disk_io_thread.hpp

@@ -311,7 +311,7 @@ namespace aux {
 			, std::function<void(status_t, std::string const&, storage_error const&)> handler) override;
 		void async_release_files(storage_index_t storage
 			, std::function<void()> handler = std::function<void()>()) override;
-		void async_delete_files(storage_index_t storage, int options
+		void async_delete_files(storage_index_t storage, remove_flags_t options
 			, std::function<void(storage_error const&)> handler) override;
 		void async_check_files(storage_index_t storage
 			, add_torrent_params const* resume_data

include/libtorrent/session.hpp

@@ -163,7 +163,7 @@ namespace aux {
 	// This function helps to construct a ``session_params`` from a
 	// bencoded data generated by ``session_handle::save_state``
 	TORRENT_EXPORT session_params read_session_params(bdecode_node const& e
-		, std::uint32_t flags = 0xffffffff);
+		, save_state_flags_t flags = save_state_flags_t{0xffffffff});
 
 	// The session holds all state that spans multiple torrents. Among other
 	// things it runs the network loop and manages all torrents. Once it's
@@ -222,7 +222,7 @@ namespace aux {
 		// default is to start those features. If you do not want them to start,
 		// pass 0 as the flags parameter.
 		session(settings_pack pack
-			, int flags = start_default_features | add_default_plugins)
+			, session_flags_t const flags = start_default_features | add_default_plugins)
 		{
 			TORRENT_CFG();
 			start(flags, std::move(pack), nullptr);
@@ -251,7 +251,7 @@ namespace aux {
 		// 	destruct the session_proxy object.
 		session(settings_pack pack
 			, io_service& ios
-			, int flags = start_default_features | add_default_plugins)
+			, session_flags_t const flags = start_default_features | add_default_plugins)
 		{
 			TORRENT_CFG();
 			start(flags, std::move(pack), &ios);
@@ -272,14 +272,14 @@ namespace aux {
 #endif
 		TORRENT_DEPRECATED
 		session(fingerprint const& print
-			, int flags = start_default_features | add_default_plugins
-			, std::uint32_t alert_mask = alert::error_notification)
+			, session_flags_t const flags = start_default_features | add_default_plugins
+			, alert_category_t const alert_mask = alert::error_notification)
 		{
 			TORRENT_CFG();
 			settings_pack pack;
 			pack.set_int(settings_pack::alert_mask, int(alert_mask));
 			pack.set_str(settings_pack::peer_fingerprint, print.to_string());
-			if ((flags & start_default_features) == 0)
+			if (!(flags & start_default_features))
 			{
 				pack.set_bool(settings_pack::enable_upnp, false);
 				pack.set_bool(settings_pack::enable_natpmp, false);
@@ -294,8 +294,8 @@ namespace aux {
 		session(fingerprint const& print
 			, std::pair<int, int> listen_port_range
 			, char const* listen_interface = "0.0.0.0"
-			, int flags = start_default_features | add_default_plugins
-			, int alert_mask = alert::error_notification)
+			, session_flags_t const flags = start_default_features | add_default_plugins
+			, alert_category_t const alert_mask = alert::error_notification)
 		{
 			TORRENT_CFG();
 			TORRENT_ASSERT(listen_port_range.first > 0);
@@ -311,7 +311,7 @@ namespace aux {
 			std::snprintf(if_string, sizeof(if_string), "%s:%d", listen_interface, listen_port_range.first);
 			pack.set_str(settings_pack::listen_interfaces, if_string);
 
-			if ((flags & start_default_features) == 0)
+			if (!(flags & start_default_features))
 			{
 				pack.set_bool(settings_pack::enable_upnp, false);
 				pack.set_bool(settings_pack::enable_natpmp, false);
@@ -362,7 +362,7 @@ namespace aux {
 	private:
 
 		void start(session_params params, io_service* ios);
-		void start(int flags, settings_pack sp, io_service* ios);
+		void start(session_flags_t flags, settings_pack sp, io_service* ios);
 
 		// data shared between the main thread
 		// and the working thread