3aced2ac244d0094528726921dd16afebca29f0d
[dbus-ada.git] / src / d_bus-messages.ads
1 --
2 --  D_Bus/Ada - An Ada binding to D-Bus
3 --
4 --  Copyright (C) 2011  Reto Buerki <reet@codelabs.ch>
5 --
6 --  This program is free software; you can redistribute it and/or
7 --  modify it under the terms of the GNU General Public License
8 --  as published by the Free Software Foundation; either version 2
9 --  of the License, or (at your option) any later version.
10 --
11 --  This program is distributed in the hope that it will be useful,
12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 --  GNU General Public License for more details.
15 --
16 --  You should have received a copy of the GNU General Public License
17 --  along with this program; if not, write to the Free Software
18 --  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
19 --  USA.
20 --
21 --  As a special exception, if other files instantiate generics from this
22 --  unit,  or  you  link  this  unit  with  other  files  to  produce  an
23 --  executable   this  unit  does  not  by  itself  cause  the  resulting
24 --  executable to  be  covered by the  GNU General  Public License.  This
25 --  exception does  not  however  invalidate  any  other reasons why  the
26 --  executable file might be covered by the GNU Public License.
27 --
28
29 with dbus_message_h;
30 with D_Bus.Arguments;
31
32 package D_Bus.Messages is
33
34    type Message_Variant is
35      (Invalid,
36       Method_Call,
37       Method_Return,
38       Error,
39       Signal);
40    --  D-Bus message types.
41
42    type Message_Type is private;
43    --  A D-Bus message, see the section 'Message Format' in the D-Bus
44    --  specification.
45
46    Null_Message : constant Message_Type;
47
48    function New_Method_Return (Method_Call : Message_Type) return Message_Type;
49    --  Constructs a message that is a reply to a method call.
50
51    function New_Error
52      (Reply_To      : Message_Type;
53       Error_Name    : String;
54       Error_Message : String)
55       return Message_Type;
56    --  Creates a new message that is an error reply to another message.
57
58    function Create
59      (D_Msg : access dbus_message_h.DBusMessage)
60       return Message_Type;
61    --  Create message object from low-level D-Bus message.
62
63    function Get_Type (Msg : Message_Type) return Message_Variant;
64    --  Return the message's type.
65
66    function Get_Serial (Msg : Message_Type) return Positive;
67    --  Return the message's serial number.
68
69    function Get_Sender (Msg : Message_Type) return String;
70    --  Return the message's sender.
71
72    function Get_Destination (Msg : Message_Type) return String;
73    --  Return the message's destination.
74
75    function Get_Path (Msg : Message_Type) return String;
76    --  Return the path.
77
78    function Get_Interface (Msg : Message_Type) return String;
79    --  Return the called interface.
80
81    function Get_Member (Msg : Message_Type) return String;
82    --  Return the member; either the method name or signal name.
83
84    function Get_Arguments
85      (Msg : Message_Type)
86       return Arguments.Argument_List_Type;
87    --  Return the message's arguments (if any).
88
89    procedure Add_Arguments
90      (Msg  : in out Message_Type;
91       Args :        Arguments.Argument_List_Type);
92    --  Add given arguments to message.
93
94    function Is_Method_Call
95      (Msg    : Message_Type;
96       Iface  : String;
97       Method : String)
98       return Boolean;
99    --  Checks whether the given message is a method call with specified
100    --  interface and member fields.
101
102    function Is_Null (Msg : Message_Type) return Boolean;
103    --  Returns True if given message is nil.
104
105    procedure Unref (Msg : in out Message_Type);
106    --  Unreference given message.
107
108    function To_Thin
109      (Msg : Message_Type)
110       return access dbus_message_h.DBusMessage;
111    --  Helper function to convert the Ada D-Bus message to a thin binding
112    --  memory address.
113
114    function To_Thick
115      (Thin : access dbus_message_h.DBusMessage)
116       return Message_Type;
117    --  Helper function to convert thin binding message to Ada D-Bus message.
118
119 private
120
121    type Message_Type is record
122       Thin_Msg : access dbus_message_h.DBusMessage := null;
123    end record;
124
125    Null_Message : constant Message_Type := (Thin_Msg => null);
126
127    function To_Thick
128      (Thin : access dbus_message_h.DBusMessage)
129       return Message_Type
130    is (Thin_Msg => Thin);
131
132    function Is_Null (Msg : Message_Type) return Boolean
133    is (Msg = Null_Message);
134
135 end D_Bus.Messages;