Static attributes (#14)

* experimenting with adding of static attributes

* not really working that well atm,
pycharm ignores that subobjects returns lists

* update for latest python versions

Author: LatvianPython

.todo.py

@@ -8,12 +8,38 @@
 #  **    d2fprgvn_GetValueName(d2fctx, D2FP_ALT_STY, D2FC_ALST_CAUTION, &vname)
 #  **    returns "Caution" in the vname [OUT] parameter.
 
+
 # todo:
 #  **    d2fprgvv_GetValueValue(d2fctx, D2FP_ALT_STY, "Caution", &val)
 #  **    returns 1 in the val [OUT] parameter.
 
+
 # todo:
 #  d2fobdu_Duplicate( d2fctx *pd2fctx, d2fob *new_owner, d2fob *pd2fob_src, d2fob **ppd2fob_dst, text *new_name );
 
+
 # todo:
 #  d2fobfo_FindObj(d2fctx *pd2fctx, d2fob *owner, text *name, d2fotyp objtyp, d2fob **ppd2fob );
+
+
+# todo: property numbers for data sources and arguments..
+#  368 -- Query Data Source Columns
+#  369 -- Query Data Source Arguments
+#  420 -- Insert Procedure Result Set Columns
+#  421 -- Insert Procedure Arguments
+#  423 -- Update Procedure Result Set Columns
+#  424 -- Update Procedure Arguments
+#  426 -- Delete Procedure Result Set Columns
+#  427 -- Delete Procedure Arguments
+#  429 -- Lock Procedure Result Set Columns
+#  430 -- Lock Procedure Arguments
+#  508 -- Query Column Object
+#  509 -- Query Argument Object
+#  510 -- Insert Column Object
+#  511 -- Insert Argument Object
+#  512 -- Update Column Object
+#  513 -- Update Argument Object
+#  514 -- Delete Column Object
+#  515 -- Delete Argument Object
+#  516 -- Lock Column Object
+#  517 -- Lock Argument Object

.travis.yml

@@ -1,7 +1,7 @@
 language: python
 python:
-  - '3.7'
-  - '3.8'
+  - '3.9'
+  - '3.10'
 install:
   - pip install -r requirements.txt
   - pip install .

media/coverage.svg

@@ -46,4 +46,5 @@ def initialize_context(version: str = "12c", encoding: str = "utf-8") -> None:
     api_objects = read_api_objects(version=version)
 
     for forms_object in registered_objects.values():
-        add_properties(forms_object, api_objects)
+        if forms_object != Module:
+            add_properties(forms_object, api_objects)

pyoracle_forms/__init__.py

@@ -218,6 +218,12 @@ def property_type(property_number: int) -> int:
     return int(api_function("d2fprgt_GetType", (c_uint,))(property_number))
 
 
+def property_constant_number(property_const_name: str) -> int:
+    return handled_api_function("d2fprgcv_GetConstValue", (c_char_p, c_void_p), 1)(
+        property_const_name.encode("utf-8"), c_int()
+    ).value
+
+
 def object_number(obj_name: str) -> int:
     return int(
         handled_api_function(

pyoracle_forms/context.py

@@ -1,4 +1,3 @@
-from functools import wraps
 from typing import NoReturn
 
 error_mapping = {

pyoracle_forms/error_handling.py

@@ -1,10 +1,9 @@
 import json
 import pathlib
-from typing import Dict, Tuple, Optional
 from ctypes import *
 from os import pathsep, environ
 from os.path import exists, abspath, join
-
+from typing import Dict, Tuple, Optional
 
 dll_names = {
     "12c": ("frmd2f.dll", "msvcr100"),

pyoracle_forms/forms_api.py

@@ -1,20 +1,78 @@
 from __future__ import annotations
 
 from ctypes import c_void_p
-from typing import Optional, Any, Type
 from types import TracebackType
+from typing import Optional, Type, List
 
 from .context import create_module
 from .context import load_module
 from .context import save_module
 from .generic_object import GenericObject, BaseObject, FormsObjects
-from .misc import forms_object
+from .misc import forms_object, Text, Number, Object, Bool, Subobjects
 
 
 @forms_object
 class Module(BaseObject):
     object_type = FormsObjects.module
 
+    name = Text("NAME")
+    comments = Text("COMMENT")
+    console_window = Text("CONSOLE_WIN")
+    cursor_mode = Number("CRSR_MODE")
+    direction = Number("LANG_DIR")
+    first_navigation_data_block = Text("FRST_NAVIGATION_BLK_NAM")
+    menu_module = Text("MNU_MOD")
+    menu_role = Text("MNU_ROLE")
+    initial_menu = Text("INIT_MNU")
+    form_horizontal_toolbar_canvas = Text("HORZ_TLBR_CNV")
+    form_vertical_toolbar_canvas = Text("VERT_TLBR_CNV")
+    mouse_navigation_limit = Number("MOUSE_NAVIGATION_LMT")
+    current_record_visual_attribute_group = Text("REC_VAT_GRP_NAM")
+    savepoint_mode = Bool("SVPNT_MODE")
+    title = Text("TITLE")
+    use_3d_controls = Bool("USE_3D_CNTRLS")
+    validation_unit = Number("VALIDATION_UNIT")
+    title_string_id = Number("TITLE_STRID")
+    interaction_mode = Number("INTERACTION_MODE")
+    maximum_query_time = Number("MAX_QRY_TIME")
+    maximum_records_fetched = Number("MAX_RECS_FETCHED")
+    isolation_mode = Number("ISOLATION_MODE")
+    parent_objects_module = Text("PAR_MODULE")
+    parent_objects_module_type = Number("PAR_MODTYP")
+    parent_object_name = Text("PAR_NAM")
+    parent_objects_file_name = Text("PAR_FLNAM")
+    parent_objects_file_path = Text("PAR_FLPATH")
+    runtime_compatibility_mode = Number("RUNTIME_COMP")
+    parent_objects_type = Number("PAR_TYP")
+    help_book_title = Text("HELP_BOOK_TITLE")
+    defer_required_enforcement = Number("NEWDEFER_REQ_ENF")
+
+    alerts = Subobjects["Alert"]("ALERT")  # type: List[Alert]
+    attached_libraries: List[AttachedLibrary] = Subobjects("ATT_LIB")
+    data_blocks: List[DataBlock] = Subobjects("BLOCK")
+    canvases: List[Canvas] = Subobjects("CANVAS")
+    editors: List[Editor] = Subobjects("EDITOR")
+    form_parameters: List[FormParameter] = Subobjects("FORM_PARAM")
+    lovs: List[LOV] = Subobjects("LOV")
+    menus: List[Menu] = Subobjects("MENU")
+    triggers: List[Trigger] = Subobjects("TRIGGER")
+    visual_attributes: List[VisualAttribute] = Subobjects("VIS_ATTR")
+    windows: List[Window] = Subobjects("WINDOW")
+    reports: List[Report] = Subobjects("REPORT")
+    object_groups: List[ObjectGroup] = Subobjects("OBJ_GRP")
+    program_units: List[ProgramUnit] = Subobjects("PROG_UNIT")
+    property_classes: List[PropertyClass] = Subobjects("PROP_CLASS")
+    record_groups: List[RecordGroup] = Subobjects("REC_GRP")
+    events: List[Event] = Subobjects("EVENT")
+
+    first_data_block_object = Object("FRST_NAVIGATION_BLK_OBJ")
+
+    next_object = Object("NEXT")
+    previous_object = Object("PREVIOUS")
+    source_object = Object("SOURCE")
+
+    current_record_va_pointer = Object("REC_VAT_GRP_OBJ")
+
     def __init__(self, module: c_void_p, path: str):
         super().__init__(module)
         self.path = path
@@ -42,6 +100,10 @@ def save(self, path: Optional[str] = None) -> None:
         save_module(module=self, path=path or self.path)
 
 
+# modu = Module(1, "")
+# reveal_type(modu.alerts[0])
+
+
 @forms_object
 class AttachedLibrary(GenericObject):
     object_type = FormsObjects.attached_library

pyoracle_forms/forms_objects.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
-from typing import Callable, Dict, Optional, Any, Tuple, Union, TYPE_CHECKING
-from ctypes import c_void_p
 import enum
+from ctypes import c_void_p
+from typing import Callable, Dict, Optional, Tuple, Union, TYPE_CHECKING
 
+from .context import context
 from .context import create
 from .context import destroy
 from .context import get_boolean
@@ -16,7 +17,6 @@
 from .context import set_number
 from .context import set_object
 from .context import set_text
-from .context import context
 
 if TYPE_CHECKING:
     from .context import Setter
@@ -88,8 +88,11 @@ class BaseObject:
     _object_number: Optional[int]
     _as_parameter_: c_void_p
 
-    def __init__(self, generic_object: c_void_p) -> None:
-        self._as_parameter_ = generic_object
+    def __init__(self, generic_object: Union[c_void_p, BaseObject]) -> None:
+        try:
+            self._as_parameter_ = generic_object._as_parameter_
+        except AttributeError:
+            self._as_parameter_ = generic_object
 
     def has_property(self, property_number: int) -> bool:
         return has_property(self, property_number)

pyoracle_forms/generic_object.py

@@ -1,22 +1,32 @@
 import enum
 from ctypes import c_void_p
-from typing import Dict, Callable, Type, Tuple, Union, NoReturn, Any, Iterable, List
-
+from typing import (
+    Dict,
+    Type,
+    Tuple,
+    Union,
+    NoReturn,
+    Iterable,
+    List,
+    TypeVar,
+    Generic,
+)
+
+from .context import context
+from .context import get_boolean
+from .context import get_number
+from .context import get_object
+from .context import get_text
 from .context import object_name
 from .context import property_constant_name
+from .context import property_constant_number
 from .context import property_name
 from .context import query_type
-from .generic_object import BaseObject, GenericObject, PropertyTypes
-
-# todo: for the future...
-#  from .context import get_boolean
-#  from .context import get_number
-#  from .context import get_object
-#  from .context import get_text
-#  from .context import set_boolean
-#  from .context import set_number
-#  from .context import set_object
-#  from .context import set_text
+from .context import set_boolean
+from .context import set_number
+from .context import set_object
+from .context import set_text
+from .generic_object import BaseObject, PropertyTypes
 
 registered_objects: Dict[str, Type[BaseObject]] = {}
 
@@ -65,15 +75,68 @@ def __set__(self, instance: BaseObject, value: PropertyTypes) -> None:
         instance.set_property(self.property_number, value)
 
 
-class Subobjects:
-    def __init__(self, property_number: int, prop_name: str) -> None:
-        self.property_number, self.property_name = property_number, prop_name
+class Text:
+    def __init__(self, constant: str):
+        self.constant = constant
+
+    def __get__(self, instance: BaseObject, owner: Type[BaseObject]) -> str:
+        return (
+            get_text(instance, property_constant_number(self.constant)) or b""
+        ).decode(context.encoding)
+
+    def __set__(self, instance: BaseObject, value: str) -> None:
+        set_text(
+            instance,
+            property_constant_number(self.constant),
+            value.encode(context.encoding),
+        )
+
+
+class Bool:
+    def __init__(self, constant: str):
+        self.constant = constant
+
+    def __get__(self, instance: BaseObject, owner: Type[BaseObject]) -> bool:
+        return get_boolean(instance, property_constant_number(self.constant))
+
+    def __set__(self, instance: BaseObject, value: bool) -> None:
+        set_boolean(instance, property_constant_number(self.constant), value)
+
+
+class Number:
+    def __init__(self, constant: str):
+        self.constant = constant
+
+    def __get__(self, instance: BaseObject, owner: Type[BaseObject]) -> int:
+        return get_number(instance, property_constant_number(self.constant))
+
+    def __set__(self, instance: BaseObject, value: int) -> None:
+        set_number(instance, property_constant_number(self.constant), value)
+
+
+class Object:
+    def __init__(self, constant: str):
+        self.constant = constant
+
+    def __get__(self, instance: BaseObject, owner: Type[BaseObject]) -> BaseObject:
+        return BaseObject(get_object(instance, property_constant_number(self.constant)))
+
+    def __set__(self, instance: BaseObject, value: BaseObject) -> None:
+        set_object(instance, property_constant_number(self.constant), value)
+
+
+T = TypeVar("T")
+
+
+class Subobjects(Generic[T]):
+    def __init__(self, constant: str) -> None:
+        self.constant = constant
 
-    def __get__(
-        self, instance: BaseObject, owner: Type[BaseObject]
-    ) -> List[BaseObject]:
-        def gen_subobjects() -> Iterable[BaseObject]:
-            first_child: c_void_p = instance.get_property(self.property_number)
+    def __get__(self, instance: BaseObject, owner: Type[BaseObject]) -> List[T]:
+        def gen_subobjects() -> Iterable[T]:
+            first_child: c_void_p = instance.get_property(
+                property_constant_number(self.constant)
+            )
             if first_child:
                 obj_name = object_name(query_type(first_child))
                 klass = registered_objects[obj_name]
@@ -85,7 +148,7 @@ def gen_subobjects() -> Iterable[BaseObject]:
         subobjects = list(gen_subobjects())
         return subobjects
 
-    def __set__(self, instance: BaseObject, value: None) -> NoReturn:
+    def __set__(self, instance: BaseObject, value: List[T]) -> NoReturn:
         raise AttributeError("can't set attribute")
 
 
@@ -103,7 +166,7 @@ def property_attribute(property_number: int) -> Tuple[str, Union[Property, Subob
         return prop_name, Property(property_number)
     else:
         prop_name = obj_property.name
-        return prop_name, Subobjects(property_number, prop_name)
+        return prop_name, Subobjects(property_constant_name(property_number))
 
 
 def object_type(cls: Type[BaseObject], api_objects: Dict) -> Tuple[Dict, int]: