File: gtkada-types.ads

------------------------------------------------------------------------------

--               GtkAda - Ada95 binding for the Gimp Toolkit                --

--                                                                          --

--                     Copyright (C) 1998-2014, 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.Strings; 
```
```
 
```

package Gtkada.TypesTo API doc
To spec
To body is

```
 
```
```
   pragma Preelaborate; 
```
```
 
```
```
   Data_Error : exception; 
```
```
 
```

   subtype Chars_Ptr is Interfaces.C.Strings.chars_ptr;

   subtype Chars_Ptr_Array is Interfaces.C.Strings.chars_ptr_array;

```
 
```

   procedure g_freeTo API doc
To body (Mem : Chars_PtrTo API doc
To spec);

   --  Free a C string returned from Gtk

```
 
```

   Null_Ptr : Chars_PtrTo API doc
To spec renames Interfaces.C.Strings.Null_Ptr;

```
 
```

   function Null_ArrayTo API doc
To body return Chars_Ptr_ArrayTo API doc
To spec;

```
   --  Return a null array. 
```

   pragma Inline (Null_ArrayTo API doc
To spec
To body);

```
 
```

   -------------------------------------

   --  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 "+"To API doc
To body (S1, S2 : String) return Chars_Ptr_ArrayTo API doc
To spec;

   --  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 "+"To API doc
To body (S1 : Chars_Ptr_ArrayTo API doc
To spec; S2 : String) return Chars_Ptr_ArrayTo API doc
To spec;

```
   --  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 "+"To API doc
To body (S1 : Chars_Ptr_ArrayTo API doc
To spec; S2 : Chars_PtrTo API doc
To spec) return Chars_Ptr_ArrayTo API doc
To spec;

```
   --  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 "+"To API doc
To body (S1 : Chars_PtrTo API doc
To spec; S2 : String) return Chars_Ptr_ArrayTo API doc
To spec;

   --  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 FreeTo API doc
To body (A : in out Chars_Ptr_ArrayTo API doc
To spec);

```
   --  Free all the strings in A. 
```
```
 
```
```
private 
```

   pragma Import (C, g_freeTo API doc
To spec, "g_free");

end Gtkada.TypesTo API doc
To spec
To body;

Documentation