sphinx-compatible declaration of s4u::ActorPtr and co

[simgrid.git] / include / simgrid / forward.h

diff --git a/include/simgrid/forward.h b/include/simgrid/forward.h
index 59b45c7..3661be2 100644 (file)
--- a/include/simgrid/forward.h
+++ b/include/simgrid/forward.h
@@ -6,14 +6,73 @@
 #ifndef SIMGRID_TYPES_H
 #define SIMGRID_TYPES_H
 
-#ifdef __cplusplus
-
-#include <simgrid/s4u/forward.hpp>
 #include <xbt/base.h>
 
+#ifdef __cplusplus
+
 #include <boost/intrusive_ptr.hpp>
 
 namespace simgrid {
+
+namespace s4u {
+class Activity;
+
+class Actor;
+/** Smart pointer to a simgrid::s4u::Actor */
+typedef boost::intrusive_ptr<Actor> ActorPtr;
+XBT_PUBLIC void intrusive_ptr_release(Actor* actor);
+XBT_PUBLIC void intrusive_ptr_add_ref(Actor* actor);
+
+class Barrier;
+
+class Comm;
+/** Smart pointer to a simgrid::s4u::Comm */
+typedef boost::intrusive_ptr<Comm> CommPtr;
+XBT_PUBLIC void intrusive_ptr_release(Comm* c);
+XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
+
+class ConditionVariable;
+/** Smart pointer to a simgrid::s4u::ConditionVariable */
+typedef boost::intrusive_ptr<ConditionVariable> ConditionVariablePtr;
+XBT_PUBLIC void intrusive_ptr_release(ConditionVariable* c);
+XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariable* c);
+
+class Engine;
+
+class Exec;
+/** Smart pointer to a simgrid::s4u::Exec */
+typedef boost::intrusive_ptr<Exec> ExecPtr;
+XBT_PUBLIC void intrusive_ptr_release(Exec* e);
+XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
+
+class Host;
+
+class Io;
+/** Smart pointer to a simgrid::s4u::Io */
+typedef boost::intrusive_ptr<Io> IoPtr;
+XBT_PUBLIC void intrusive_ptr_release(Io* i);
+XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
+
+class Link;
+
+class Mailbox;
+/** Smart pointer to a simgrid::s4u::Mailbox */
+typedef boost::intrusive_ptr<Mailbox> MailboxPtr;
+XBT_PUBLIC void intrusive_ptr_release(Mailbox* m);
+XBT_PUBLIC void intrusive_ptr_add_ref(Mailbox* m);
+
+class Mutex;
+XBT_PUBLIC void intrusive_ptr_release(Mutex* m);
+XBT_PUBLIC void intrusive_ptr_add_ref(Mutex* m);
+/** Smart pointer to a simgrid::s4u::Mutex */
+typedef boost::intrusive_ptr<Mutex> MutexPtr;
+
+class NetZone;
+class VirtualMachine;
+class File;
+class Storage;
+} // namespace s4u
+
 namespace config {
 template <class T> class Flag;
 }
@@ -24,12 +83,15 @@ namespace actor {
 class ActorImpl;
 using ActorImplPtr = boost::intrusive_ptr<ActorImpl>;
 } // namespace actor
+
 namespace activity {
   class ActivityImpl;
   using ActivityImplPtr = boost::intrusive_ptr<ActivityImpl>;
   XBT_PUBLIC void intrusive_ptr_add_ref(ActivityImpl* activity);
   XBT_PUBLIC void intrusive_ptr_release(ActivityImpl* activity);
 
+  class ConditionVariableImpl;
+
   class CommImpl;
   using CommImplPtr = boost::intrusive_ptr<CommImpl>;
   class ExecImpl;
@@ -60,6 +122,7 @@ namespace resource {
 class Action;
 class Model;
 class Resource;
+class NetworkModel;
 class TraceEvent;
 class LinkImpl;
 class NetworkAction;
@@ -84,13 +147,21 @@ namespace surf {
   class StorageType;
   class StorageModel;
 }
+namespace mc {
+class CommunicationDeterminismChecker;
+}
 namespace trace_mgr {
   class trace;
   class future_evt_set;
 }
+namespace vm {
+class VMModel;
+class VirtualMachineImpl;
+} // namespace vm
 } // namespace simgrid
 
 typedef simgrid::s4u::Actor s4u_Actor;
+typedef simgrid::s4u::Barrier s4u_Barrier;
 typedef simgrid::s4u::Host s4u_Host;
 typedef simgrid::s4u::Link s4u_Link;
 typedef simgrid::s4u::File s4u_File;
@@ -102,6 +173,7 @@ typedef simgrid::trace_mgr::trace* tmgr_trace_t;
 
 typedef simgrid::kernel::context::Context* smx_context_t;
 typedef simgrid::kernel::actor::ActorImpl* smx_actor_t;
+typedef simgrid::kernel::activity::ConditionVariableImpl* smx_cond_t;
 typedef simgrid::kernel::activity::MutexImpl* smx_mutex_t;
 typedef simgrid::kernel::activity::MailboxImpl* smx_mailbox_t;
 typedef simgrid::surf::StorageImpl* surf_storage_t;
@@ -109,6 +181,7 @@ typedef simgrid::surf::StorageImpl* surf_storage_t;
 #else
 
 typedef struct s4u_Actor s4u_Actor;
+typedef struct s4u_Barrier s4u_Barrier;
 typedef struct s4u_Host s4u_Host;
 typedef struct s4u_Link s4u_Link;
 typedef struct s4u_File s4u_File;
@@ -119,12 +192,14 @@ typedef struct kernel_Activity* smx_activity_t;
 
 typedef struct s_smx_context* smx_context_t;
 typedef struct s_smx_actor* smx_actor_t;
+typedef struct s_smx_cond_t* smx_cond_t;
 typedef struct s_smx_mutex* smx_mutex_t;
 typedef struct s_smx_mailbox* smx_mailbox_t;
 typedef struct s_surf_storage* surf_storage_t;
 
 #endif
 
+typedef s4u_Barrier* sg_bar_t;
 typedef s4u_NetZone* sg_netzone_t;
 typedef s4u_Host* sg_host_t;
 typedef s4u_Link* sg_link_t;