/usr/share/ada/adainclude/gnatcoll_python/gnatcoll-scripts-python.ads is in libgnatcoll-python16.1.0-dev 17.0.2017-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 | ------------------------------------------------------------------------------
-- G N A T C O L L --
-- --
-- Copyright (C) 2003-2017, 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. --
-- --
-- --
-- --
-- --
-- --
-- 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/>. --
-- --
------------------------------------------------------------------------------
pragma Ada_05;
with Ada.Strings.Unbounded;
with GNATCOLL.Python; use GNATCOLL.Python;
with System;
package GNATCOLL.Scripts.Python is
Python_Name : constant String := "python";
procedure Register_Python_Scripting
(Repo : access Scripts.Scripts_Repository_Record'Class;
Module : String;
Program_Name : String := "python";
Python_Home : String := "");
-- All commands and classes will be added in the specified module.
--
-- Program_Name should be the name of the program registering Python
-- scripting. The interpreter will resove run-time libraries relative to
-- this executable.
--
-- If Python_Home is non-empty, it will be used as home, and libraries will
-- be searched for in <Python_Home>/lib/python<version>
procedure Unregister_Python_Scripting
(Repo : access Scripts.Scripts_Repository_Record'Class);
-- Mark the python scripting language as no longer valid. This should be
-- called before your application exits, to prevent unwanted storage_error
-- in the finalization of the application (since some class_instances might
-- be automatically finalized after python itself was destroyed, otherwise)
type Python_Scripting_Record is new Scripting_Language_Record with private;
type Python_Scripting is access all Python_Scripting_Record'Class;
pragma No_Strict_Aliasing (Python_Scripting);
type Python_Callback_Data is new Callback_Data with private;
function Get_Param
(Data : Python_Callback_Data'Class; N : Positive)
return PyObject;
procedure Get_Param
(Data : Python_Callback_Data'Class;
N : Positive;
Result : out PyObject;
Success : out Boolean);
-- Return the N-th command line parameter, taking into account the keywords
-- if any.
-- The returned value is a borrowed reference and must not be DECREF'd
procedure Set_Nth_Arg
(Data : in out Python_Callback_Data;
N : Positive; Value : PyObject);
-- Sets the N-th command line parameter using a low-level PyObject.
procedure Set_Return_Value
(Data : in out Python_Callback_Data; Value : PyObject);
-- Sets the return value using a low-level PyObject.
-- The refcounting of Value is increased.
function Run_Command
(Script : access Python_Scripting_Record'Class;
Command : String;
Need_Output : Boolean;
Console : Virtual_Console := null;
Show_Command : Boolean := False;
Hide_Output : Boolean := False;
Hide_Exceptions : Boolean := False;
Errors : access Boolean) return PyObject;
-- Execute a command in the interpreter, and send its output to the
-- console. Return its return value (which doesn't need to be Py_DECREF,
-- since it is a borrowed reference).
-- If Hide_Output is True, then nothing is printed on the console. If the
-- command is incomplete and would require extra input (a secondary prompt
-- in interactive mode), then it is not executed.
-- Errors is set to True if there was an error executing the command or
-- if the input was incomplete.
--
-- If Need_Output is True, the result of Command will be returned
-- (otherwise Py_None is returned). However, this also restricts what
-- commands can be executed, since only expressions can be called (ie not
-- function definitions or import statements, for instance).
function Get_PyObject (Instance : Class_Instance) return PyObject;
-- Returns the low level PyObject enclosed in a Python Class_Instance.
-- You need to be absolutely sure that Instance is a Python Instance.
--------------------------
-- Multitasking support --
--------------------------
-- Python itself is not task-safe. It uses a Global Interpreter Lock to
-- make sure that a single thread is accessing it at any one time. However,
-- to simulate parallelism, it will automatically release and re-acquire
-- the lock every 100 or so opcode instructions, thus giving a chance to
-- run to other threads.
--
-- This has several implications on multitasking Ada programs that want to
-- access python:
-- - the tasks that do not need to access python do not need anything
-- special and can be left as is.
-- - other tasks must create a python-specific data structure associated
-- with the task. This is done by Ensure_Thread_State below.
--
-- In addition, whenever you want to access python, you need to first
-- acquire the Global Interpreter Lock (which can conveniently be done
-- through Ensure_Thread_Safe). You should then release it when you are
-- done manipulating python data structures, through a call to
-- Begin_Allow_Threads. As such, a typical Ada program would look like:
--
-- Register_Python_Scripting (...);
-- Initialize_Threads_Support;
-- Begin_Allow_Threads;
--
-- and then in all tasks that access python:
--
-- Ensure_Thread_State;
-- ... python commands
-- Begin_Allow_Threads;
--
-- NOTE:
-- The following functions have no effect if python was compiled without
-- support for threading. They do not raise an exception either, so that
-- you can run the code even if python doesn't have threads.
--
-- Input-Output and multi-tasking
-- ------------------------------
--
-- In a multi-tasking application, it is recommended that you always call
-- the various Execute_Command subprograms with Hide_Output=>False.
-- Otherwise, there might be some confusion where a thread disabled the
-- output (which is done by redirecting sys.stdout) but the next one
-- puts its back, and thus the output of the first thread is visible in
-- the end. This also seems to avoid some errors in the python interpreter
-- itself.
Has_Thread_Support : constant Boolean;
pragma Import (C, Has_Thread_Support, "python_with_thread");
-- Whether python was compiled with support for threading.
procedure Initialize_Threads_Support;
-- Add support for multi-tasking on the python side. This also acquires the
-- Global Interpreter Lock, so you should call Begin_Allow_Threads later on
-- to allow other threads to run.
type PyThreadState is private;
function Begin_Allow_Threads return PyThreadState;
procedure Begin_Allow_Threads;
-- Allow other python threads to run (for instance because we are blocked
-- in a system call or in a section of code that doesn't need to execute
-- python commands). This also releases the Global Interpreter Lock.
procedure End_Allow_Threads (State : PyThreadState);
-- Acquires the Global Interpreter Lock, and make State the current
-- python thread. It must correspond to the current system thread.
function Get_This_Thread_State return PyThreadState;
-- Return the python thread state corresponding to the current
-- system thread (hopefully this is also the current python thread,
-- but there is no guarantee)
procedure Ensure_Thread_State;
-- Make sure that the current system thread has an equivalent python
-- thread state. This should be called for all tasks created in Ada and
-- that need to access python commands.
-- This also makes sure that the current python thread state matches the
-- system thread (so basically lets python know that a different thread
-- is running).
-- Finally, this acquires the Global Interpreter Lock (it runs the
-- equivalent of End_Allow_Threads)
private
type PyThreadState is new System.Address;
----------------------
-- Python_scripting --
----------------------
type Python_Scripting_Record is new Scripting_Language_Record with record
Repo : Scripts_Repository;
Blocked : Boolean := False;
Module : PyObject;
Builtin : PyObject;
Exception_Misc : PyObject;
Exception_Missing_Args : PyObject;
Exception_Invalid_Arg : PyObject;
Exception_Unexpected : PyObject;
Globals : PyObject;
-- The global symbols for the python interpreter
Use_Secondary_Prompt : Boolean := False;
-- Which type of prompt should be displayed
Buffer : GNAT.Strings.String_Access;
-- Buffer for the command, to be added in front of any command before
-- executing. This is used for multi-line input.
Ignore_Constructor : Boolean := False;
-- Whether we are creating a new instance of a class.
-- This is used to disable the call to __init__ (for backward
-- compatibility and because we wouldn't know how to pass extra
-- arguments to New_Instance).
In_Process : Boolean := False;
-- True while we are processing a command. This is used to control the
-- behavior of control-c: either interrupt, or copy.
Current_File : Ada.Strings.Unbounded.Unbounded_String;
-- The script we are currently executing
end record;
overriding function Command_Line_Treatment
(Script : access Python_Scripting_Record) return Command_Line_Mode;
overriding procedure Destroy (Script : access Python_Scripting_Record);
overriding procedure Block_Commands
(Script : access Python_Scripting_Record; Block : Boolean);
overriding procedure Register_Command
(Script : access Python_Scripting_Record;
Cmd : Command_Descr_Access);
overriding procedure Register_Property
(Script : access Python_Scripting_Record;
Prop : Property_Descr_Access);
overriding procedure Register_Class
(Script : access Python_Scripting_Record;
Name : String;
Base : Class_Type := No_Class;
Module : Module_Type := Default_Module);
overriding function Create
(Script : access Python_Scripting_Record;
Arguments_Count : Natural) return Callback_Data'Class;
overriding function New_Instance
(Script : access Python_Scripting_Record;
Class : Class_Type) return Class_Instance;
overriding procedure Execute_Command
(Script : access Python_Scripting_Record;
CL : Arg_List;
Console : Virtual_Console := null;
Hide_Output : Boolean := False;
Show_Command : Boolean := True;
Errors : out Boolean);
overriding function Execute_Command
(Script : access Python_Scripting_Record;
CL : Arg_List;
Console : Virtual_Console := null;
Hide_Output : Boolean := False;
Show_Command : Boolean := True;
Errors : access Boolean) return String;
overriding function Execute_Command
(Script : access Python_Scripting_Record;
CL : Arg_List;
Console : Virtual_Console := null;
Hide_Output : Boolean := False;
Errors : access Boolean) return Boolean;
overriding function Execute_Command
(Script : access Python_Scripting_Record;
Command : String;
Args : Callback_Data'Class) return Boolean;
function Execute_Command
(Script : access Python_Scripting_Record'Class;
Command : PyObject;
Args : Callback_Data'Class;
Error : access Boolean) return String;
function Execute_Command
(Script : access Python_Scripting_Record'Class;
Command : PyObject;
Args : Callback_Data'Class;
Error : access Boolean) return Any_Type;
function Execute_Command
(Script : access Python_Scripting_Record'Class;
Command : PyObject;
Args : Callback_Data'Class;
Error : access Boolean) return PyObject;
-- Need to unref the returned value
function Execute_Command
(Script : access Python_Scripting_Record'Class;
Command : PyObject;
Args : Callback_Data'Class;
Error : access Boolean) return Boolean;
overriding procedure Load_Directory
(Script : access Python_Scripting_Record;
Directory : GNATCOLL.VFS.Virtual_File;
To_Load : Script_Loader := Load_All'Access);
overriding procedure Execute_File
(Script : access Python_Scripting_Record;
Filename : String;
Console : Virtual_Console := null;
Hide_Output : Boolean := False;
Show_Command : Boolean := True;
Errors : out Boolean);
overriding function Get_Name
(Script : access Python_Scripting_Record) return String;
overriding function Get_Repository
(Script : access Python_Scripting_Record) return Scripts_Repository;
overriding function Current_Script
(Script : access Python_Scripting_Record) return String;
overriding procedure Set_Default_Console
(Script : access Python_Scripting_Record;
Console : Virtual_Console);
overriding procedure Display_Prompt
(Script : access Python_Scripting_Record;
Console : Virtual_Console := null);
overriding function Get_Prompt
(Script : access Python_Scripting_Record) return String;
overriding function Interrupt
(Script : access Python_Scripting_Record) return Boolean;
overriding procedure Complete
(Script : access Python_Scripting_Record;
Input : String;
Completions : out String_Lists.List);
overriding function New_List
(Script : access Python_Scripting_Record;
Class : Class_Type := No_Class) return List_Instance'Class;
-- See doc from inherited subprograms
type Python_Callback_Data is new Callback_Data with record
Script : Python_Scripting;
Args, Kw : PyObject;
-- Args is a tuple, a list, or any iterable.
-- These are the arguments passed by python. If Name_Parameters was
-- called, these are modified in place: Kw is reset to null, and its
-- contents merged into Args. Args is resized appropriately (to the
-- number of arguments passed to Name_Parameters). This cannot be used
-- for functions with a variable number of parameters.
Return_Value : PyObject;
Return_Dict : PyObject;
Has_Return_Value : Boolean := False;
Return_As_List : Boolean := False;
First_Arg_Is_Self : Boolean;
-- True if the first argument is "self", ie we are calling a method
end record;
overriding function Clone
(Data : Python_Callback_Data) return Callback_Data'Class;
overriding function Get_Script
(Data : Python_Callback_Data) return Scripting_Language;
overriding function Number_Of_Arguments
(Data : Python_Callback_Data) return Natural;
overriding procedure Name_Parameters
(Data : in out Python_Callback_Data; Names : Cst_Argument_List);
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive) return String;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive) return Unbounded_String;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive) return Integer;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive) return Float;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive) return Boolean;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive) return Subprogram_Type;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive; Class : Class_Type;
Allow_Null : Boolean := False)
return Class_Instance;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive; Default : String)
return String;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive; Default : Integer)
return Integer;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive; Default : Boolean)
return Boolean;
overriding function Nth_Arg
(Data : Python_Callback_Data;
N : Positive;
Class : Class_Type := Any_Class;
Default : Class_Instance;
Allow_Null : Boolean := False) return Class_Instance;
overriding function Nth_Arg
(Data : Python_Callback_Data;
N : Positive;
Default : Subprogram_Type) return Subprogram_Type;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive) return List_Instance'Class;
overriding function Nth_Arg
(Data : Python_Callback_Data; N : Positive)
return Dictionary_Instance'Class;
overriding procedure Set_Error_Msg
(Data : in out Python_Callback_Data; Msg : String);
overriding procedure Set_Return_Value_As_List
(Data : in out Python_Callback_Data;
Size : Natural := 0;
Class : Class_Type := No_Class);
overriding procedure Set_Return_Value
(Data : in out Python_Callback_Data; Value : Integer);
overriding procedure Set_Return_Value
(Data : in out Python_Callback_Data; Value : Float);
overriding procedure Set_Return_Value
(Data : in out Python_Callback_Data; Value : String);
overriding procedure Set_Return_Value
(Data : in out Python_Callback_Data; Value : Boolean);
overriding procedure Set_Return_Value
(Data : in out Python_Callback_Data; Value : Class_Instance);
overriding procedure Set_Return_Value
(Data : in out Python_Callback_Data; Value : List_Instance);
overriding procedure Set_Address_Return_Value
(Data : in out Python_Callback_Data; Value : System.Address);
overriding procedure Set_Return_Value_Key
(Data : in out Python_Callback_Data;
Key : String;
Append : Boolean := False);
overriding procedure Set_Return_Value_Key
(Data : in out Python_Callback_Data;
Key : Integer;
Append : Boolean := False);
overriding procedure Set_Return_Value_Key
(Data : in out Python_Callback_Data;
Key : Class_Instance;
Append : Boolean := False);
overriding procedure Free (Data : in out Python_Callback_Data);
overriding procedure Set_Nth_Arg
(Data : in out Python_Callback_Data; N : Positive; Value : String);
overriding procedure Set_Nth_Arg
(Data : in out Python_Callback_Data; N : Positive; Value : Integer);
overriding procedure Set_Nth_Arg
(Data : in out Python_Callback_Data; N : Positive; Value : Float);
overriding procedure Set_Nth_Arg
(Data : in out Python_Callback_Data; N : Positive; Value : Boolean);
overriding procedure Set_Nth_Arg
(Data : in out Python_Callback_Data;
N : Positive; Value : Class_Instance);
overriding procedure Set_Nth_Arg
(Data : in out Python_Callback_Data;
N : Positive;
Value : List_Instance);
overriding procedure Set_Nth_Arg
(Data : in out Python_Callback_Data;
N : Positive;
Value : Subprogram_Type);
overriding procedure Execute_Command
(Args : in out Python_Callback_Data;
Command : String;
Hide_Output : Boolean := True);
overriding function Return_Value
(Data : Python_Callback_Data) return String;
overriding function Return_Value
(Data : Python_Callback_Data) return Integer;
overriding function Return_Value
(Data : Python_Callback_Data) return Float;
overriding function Return_Value
(Data : Python_Callback_Data) return Boolean;
overriding function Return_Value
(Data : Python_Callback_Data) return Class_Instance;
overriding function Return_Value
(Data : Python_Callback_Data) return List_Instance'Class;
overriding procedure Execute_Expression
(Result : in out Python_Callback_Data;
Expression : String;
Hide_Output : Boolean := True);
-- See doc from inherited subprogram
end GNATCOLL.Scripts.Python;
|