1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139 | ------------------------------------------------------------------------------
-- GtkAda - Ada95 binding for the Gimp Toolkit --
-- --
-- Copyright (C) 1998-2018, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or modify it --
-- under terms of the GNU General Public License as published by the Free --
-- Software Foundation; either version 3, or (at your option) any later --
-- version. This library is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception, --
-- version 3.1, as published by the Free Software Foundation. --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
------------------------------------------------------------------------------
-- <description>
--
-- This package provides GtkAda specific types and their associated functions.
--
-- </description>
with Interfaces.C;
with Interfaces.C.Strings;
package Gtkada.Types is
pragma Preelaborate;
Data_Error : exception;
-------------------------
-- Handling of Strings --
-------------------------
-- The Chars_Ptr type introduced below represent a C string that has been
-- allocated in C using g_malloc, and which should therefore be deallocated
-- with g_free rather than the function in Interfaces.C.Strings.
--
-- This is represented by an incompatible type, to make sure that
-- application code will use g_free.
type Chars_Ptr is private;
type Chars_Ptr_Array is array (Interfaces.C.size_t range <>)
of aliased Chars_Ptr;
procedure g_free (Mem : Chars_Ptr);
-- Free a C string that was returned from Gtk
procedure Free (Mem : in out Chars_Ptr);
-- Same as above, provided to ease API compatibility with
-- Interfaces.C.String;
function Null_Ptr return Chars_Ptr;
pragma Inline (Null_Ptr);
-- Return a null pointer
function Null_Array return Chars_Ptr_Array;
pragma Inline (Null_Array);
-- Return a null array.
function Value (Item : Chars_Ptr) return String;
pragma Inline (Value);
-- Utility conversion function
function Value
(Item : Chars_Ptr;
Length : Interfaces.C.size_t) return Interfaces.C.char_array;
pragma Inline (Value);
function Value
(Item : Chars_Ptr;
Length : Interfaces.C.size_t) return String;
pragma Inline (Value);
-- Utility conversion function
function New_String (S : String) return Chars_Ptr;
pragma Inline (New_String);
-- Create a Chars_Ptr from S. The result must be freed using g_free.
subtype char_array_access is Interfaces.C.Strings.char_array_access;
-------------------------------------
-- Handling of arrays of Strings --
-------------------------------------
-- The following functions provide a very convenient way to create
-- C arrays of null terminated strings in Ada.
--
-- You can either create such a String on the fly, or declare a variable:
--
-- Signals : Chars_Ptr_Array := "clicked" + "missed" + "new signal";
--
-- which corresponds to the C declaration:
--
-- char *signals[] = @{"clicked", "missed", "new signal"@};
--
-- Note that you still need to manually call Free (Signals) if you want to
-- release the memory dynamically allocated by the "+" functions.
function "+" (S1, S2 : String) return Chars_Ptr_Array;
-- Create an array containing S1 and S2.
-- Note that this function allocates memory to store S1 and S2 as null
-- terminated Strings. The user is responsible for calling Free on the
-- resulting array.
function "+" (S1 : Chars_Ptr_Array; S2 : String) return Chars_Ptr_Array;
-- Append S2 to S1.
-- Note that this function allocates memory to store S2 as a null
-- terminated Strings. The user is responsible for calling Free on the
-- resulting array.
function "+" (S1 : Chars_Ptr_Array; S2 : Chars_Ptr) return Chars_Ptr_Array;
-- Append S2 to S1.
-- Note that this function allocates memory to store S2 as a null
-- terminated Strings. The user is responsible for calling Free on the
-- resulting array.
function "+" (S1 : Chars_Ptr; S2 : String) return Chars_Ptr_Array;
-- Create an array containing S1 and S2.
-- Note that this function allocates memory to store S2 as a null
-- terminated string. The user is responsible for calling Free on the
-- resulting array.
procedure Free (A : in out Chars_Ptr_Array);
-- Free all the strings in A.
procedure Free (A : in out Interfaces.C.Strings.chars_ptr_array);
-- Free all the strings in A.
private
type Chars_Ptr is new Interfaces.C.Strings.chars_ptr;
pragma Import (C, g_free, "g_free");
end Gtkada.Types;
|