Merge pull request #2 from JaedanC/dev

Shortened names. Updated for breaking changes in last imgui updates

Author: JaedanC

src/config.py

@@ -7,7 +7,7 @@ import cython
 import array
 from collections import namedtuple
 from cython.operator import dereference
-from typing import Callable, Any, Sequence, Tuple, NamedTuple
+from typing import Callable, Any, Sequence, Tuple, NamedTuple, Optional
 
 cimport ccimgui
 from libcpp cimport bool
@@ -8594,25 +8594,12 @@ def show_font_selector(label: str):
 # [End Function]
 
 # [Function]
-# ?use_template(False)
-# ?active(False)
-# ?invisible(False)
-# ?custom_comment_only(False)
-# ?returns(None)
-# def show_id_stack_tool_window():
-#     """
-#     Implied p_open = null
-#     """
-#     ccimgui.ImGui_ShowIDStackToolWindow()
-# [End Function]
-
-# [Function]
-# ?use_template(False)
+# ?use_template(True)
 # ?active(True)
 # ?invisible(False)
 # ?custom_comment_only(False)
 # ?returns(None)
-def show_id_stack_tool_window_ex(p_open: Bool=None):
+def show_id_stack_tool_window(p_open: Bool=None):
     """
     Create stack tool window. hover items with mouse to query information about the source of their unique id.
     """
@@ -8621,6 +8608,21 @@ def show_id_stack_tool_window_ex(p_open: Bool=None):
     )
 # [End Function]
 
+# [Function]
+# ?use_template(False)
+# ?active(False)
+# ?invisible(True)
+# ?custom_comment_only(False)
+# ?returns(None)
+# def show_id_stack_tool_window_ex(p_open: Bool=None):
+#     """
+#     Create stack tool window. hover items with mouse to query information about the source of their unique id.
+#     """
+#     ccimgui.ImGui_ShowIDStackToolWindowEx(
+#         Bool.ptr(p_open)
+#     )
+# [End Function]
+
 # [Function]
 # ?use_template(False)
 # ?active(True)
@@ -18428,21 +18430,6 @@ cdef class ImGuiIO:
     #     )
     # [End Method]
 
-    # [Method]
-    # ?use_template(False)
-    # ?active(False)
-    # ?invisible(False)
-    # ?custom_comment_only(False)
-    # ?returns(None)
-    # def clear_input_characters(self: ImGuiIO):
-    #     """
-    #     [internal] clear the text input buffer manually
-    #     """
-    #     ccimgui.ImGuiIO_ClearInputCharacters(
-    #         self._ptr
-    #     )
-    # [End Method]
-
     # [Method]
     # ?use_template(False)
     # ?active(False)
@@ -19264,30 +19251,32 @@ cdef class ImGuiListClipper:
 
     # [Method]
     # ?use_template(False)
-    # ?active(False)
+    # ?active(True)
     # ?invisible(False)
-    # ?custom_comment_only(False)
+    # ?custom_comment_only(True)
     # ?returns(None)
-    # def include_item_by_index(self: ImGuiListClipper, item_index: int):
-    #     """
-    #     Call IncludeItemByIndex() or IncludeItemsByIndex() *BEFORE* first call to Step() if you need a range of items to not be clipped, regardless of their visibility.
-    #     (Due to alignment / padding of certain items it is possible that an extra item may be included on either end of the display range).
-    #     """
-    #     ccimgui.ImGuiListClipper_IncludeItemByIndex(
-    #         self._ptr,
-    #         item_index
-    #     )
+    def include_item_by_index(self: ImGuiListClipper, item_index: int):
+        """
+        Call IncludeItemByIndex() or IncludeItemsByIndex() *BEFORE* first call to Step() if you need a range of items to not be clipped, regardless of their visibility.
+        (Due to alignment / padding of certain items it is possible that an extra item may be included on either end of the display range).
+        """
+        ccimgui.ImGuiListClipper_IncludeItemByIndex(
+            self._ptr,
+            item_index
+        )
     # [End Method]
 
     # [Method]
     # ?use_template(False)
     # ?active(True)
     # ?invisible(False)
-    # ?custom_comment_only(False)
+    # ?custom_comment_only(True)
     # ?returns(None)
     def include_items_by_index(self: ImGuiListClipper, item_begin: int, item_end: int):
         """
         Item_end is exclusive e.g. use (42, 42+1) to make item 42 never clipped.
+
+        [#6424](https://github.com/ocornut/imgui/issues/6424) JaedanC Easteregg. This is my suggestion!
         """
         ccimgui.ImGuiListClipper_IncludeItemsByIndex(
             self._ptr,

src/core/core.pyx

@@ -7,7 +7,7 @@ import cython
 import array
 from collections import namedtuple
 from cython.operator import dereference
-from typing import Callable, Any, Sequence, Tuple, NamedTuple
+from typing import Callable, Any, Sequence, Tuple, NamedTuple, Optional
 
 cimport ccimgui
 from libcpp cimport bool

src/core/core_generated.pyx

@@ -7,7 +7,7 @@ import cython
 import array
 from collections import namedtuple
 from cython.operator import dereference
-from typing import Callable, Any, Sequence, Tuple, NamedTuple
+from typing import Callable, Any, Sequence, Tuple, NamedTuple, Optional
 
 cimport ccimgui
 from libcpp cimport bool
@@ -8594,22 +8594,24 @@ def show_font_selector(label: str):
 # [End Function]
 
 # [Function]
-# ?use_template(False)
-# ?active(False)
+# ?use_template(True)
+# ?active(True)
 # ?invisible(False)
 # ?custom_comment_only(False)
 # ?returns(None)
-def show_id_stack_tool_window():
+def show_id_stack_tool_window(p_open: Bool=None):
     """
-    Implied p_open = null
+    Create stack tool window. hover items with mouse to query information about the source of their unique id.
     """
-    ccimgui.ImGui_ShowIDStackToolWindow()
+    ccimgui.ImGui_ShowIDStackToolWindowEx(
+        Bool.ptr(p_open)
+    )
 # [End Function]
 
 # [Function]
 # ?use_template(False)
-# ?active(True)
-# ?invisible(False)
+# ?active(False)
+# ?invisible(True)
 # ?custom_comment_only(False)
 # ?returns(None)
 def show_id_stack_tool_window_ex(p_open: Bool=None):
@@ -18428,21 +18430,6 @@ cdef class ImGuiIO:
         )
     # [End Method]
 
-    # [Method]
-    # ?use_template(False)
-    # ?active(False)
-    # ?invisible(False)
-    # ?custom_comment_only(False)
-    # ?returns(None)
-    def clear_input_characters(self: ImGuiIO):
-        """
-        [internal] clear the text input buffer manually
-        """
-        ccimgui.ImGuiIO_ClearInputCharacters(
-            self._ptr
-        )
-    # [End Method]
-
     # [Method]
     # ?use_template(False)
     # ?active(False)
@@ -19264,9 +19251,9 @@ cdef class ImGuiListClipper:
 
     # [Method]
     # ?use_template(False)
-    # ?active(False)
+    # ?active(True)
     # ?invisible(False)
-    # ?custom_comment_only(False)
+    # ?custom_comment_only(True)
     # ?returns(None)
     def include_item_by_index(self: ImGuiListClipper, item_index: int):
         """
@@ -19283,11 +19270,13 @@ cdef class ImGuiListClipper:
     # ?use_template(False)
     # ?active(True)
     # ?invisible(False)
-    # ?custom_comment_only(False)
+    # ?custom_comment_only(True)
     # ?returns(None)
     def include_items_by_index(self: ImGuiListClipper, item_begin: int, item_end: int):
         """
         Item_end is exclusive e.g. use (42, 42+1) to make item 42 never clipped.
+
+        [#6424](https://github.com/ocornut/imgui/issues/6424) JaedanC Easteregg. This is my suggestion!
         """
         ccimgui.ImGuiListClipper_IncludeItemsByIndex(
             self._ptr,

src/core/core_template.pyx

@@ -3,11 +3,11 @@
 from ..comments import Comments, parse_comment
 from . import safe_python_name
 from .interfaces import IArgument, IType
-from .db_type import DearBindingsTypeNew
+from .db_type import _Type
 import re
 
 
-class DearBindingsArgumentNew(IArgument):
+class Argument(IArgument):
     def from_json(argument_json: dict) -> IArgument:
         """Argument
         {
@@ -28,7 +28,7 @@ def from_json(argument_json: dict) -> IArgument:
         """
         name = safe_python_name(argument_json["name"])
         assert not argument_json.get("is_varargs"), "Python does not support is_varargs: {}".format(name)
-        _type: IType = DearBindingsTypeNew.from_json(argument_json["type"])
+        _type: IType = _Type.from_json(argument_json["type"])
         comments: Comments = parse_comment(argument_json)
 
         default_lookup = {
@@ -56,7 +56,7 @@ def from_json(argument_json: dict) -> IArgument:
             if _type.with_no_const_or_sign() == "float":
                 default_value = default_value.replace("f", "")
 
-        return DearBindingsArgumentNew(name, _type, comments, default_value)
+        return Argument(name, _type, comments, default_value)
 
     def __init__(self, name: str, _type: IType, comments: Comments = None, default_value=None):
         self.name = name

src/model/dear_bindings/argument.py

@@ -4,11 +4,11 @@
 from ..template import Template
 from . import pythonise_string
 from .interfaces import *
-from .db_type import DearBindingsTypeNew, Kinds, Kind
-from .enum import DearBindingsEnumNew
-from .function import DearBindingsFunctionNew
-from .struct import DearBindingsStructNew
-from .typedef import DearBindingsTypedefNew
+from .db_type import _Type, Kinds, Kind
+from .enum import _Enum
+from .function import Function
+from .struct import Struct
+from .typedef import Typedef
 
 
 PYX_TEMPLATE_MARKER = "# ---- Start Generated Content ----\n\n"
@@ -85,19 +85,19 @@ def __recurse_list(_list: list, func: Callable, *args, **kwargs):
     return _json
 
 
-class DearBindingNew(IBinding):
+class Binding(IBinding):
     def from_json(cimgui_json, pxd_header: str, definitions: List[Tuple[str, bool]]):
         cimgui_json = deep_json_filter(cimgui_json, passes_conditional, definitions)
         cimgui_json = deep_json_filter(cimgui_json, ignore_anonymous)
 
-        enums = [DearBindingsEnumNew.from_json(e) for e in cimgui_json["enums"]]
-        typedefs = [DearBindingsTypedefNew.from_json(e) for e in cimgui_json["typedefs"]]
-        structs = [DearBindingsStructNew.from_json(e) for e in cimgui_json["structs"]]
+        enums = [_Enum.from_json(e) for e in cimgui_json["enums"]]
+        typedefs = [Typedef.from_json(e) for e in cimgui_json["typedefs"]]
+        structs = [Struct.from_json(e) for e in cimgui_json["structs"]]
         functions = []
 
         methods: List[IFunction] = []
         for function in cimgui_json["functions"]:
-            function = DearBindingsFunctionNew.from_json(function)
+            function = Function.from_json(function)
             if len(function.get_arguments()) > 0 and function.get_arguments()[0].get_name() == "self":
                 methods.append(function)
                 continue
@@ -112,7 +112,7 @@ def from_json(cimgui_json, pxd_header: str, definitions: List[Tuple[str, bool]])
             method.set_python_name(method.get_python_name().replace(class_name + "_", "", 1))
             struct_lookup[class_name].add_method(method)
 
-        return DearBindingNew(enums, typedefs, structs, functions, pxd_header)
+        return Binding(enums, typedefs, structs, functions, pxd_header)
 
     def __init__(
             self,
@@ -215,7 +215,7 @@ def to_pyx(self, pxd_library_name: str, include_base: bool) -> str:
         import array
         from collections import namedtuple
         from cython.operator import dereference
-        from typing import Callable, Any, Sequence, Tuple, NamedTuple
+        from typing import Callable, Any, Sequence, Tuple, NamedTuple, Optional
 
         cimport ccimgui
         from libcpp cimport bool
@@ -1026,7 +1026,7 @@ def follow_type(self, _type: IType) -> IType:
 
         for enum in self.enums:
             if enum.get_name() == _type.with_no_const_or_asterisk():
-                return DearBindingsTypeNew(
+                return _Type(
                     "int",
                     Kind(Kinds.Builtin, "int")
                 )

src/model/dear_bindings/binding.py

@@ -144,7 +144,7 @@ def to_pxd(self):
         )
 
 
-class DearBindingsTypeNew(IType):
+class _Type(IType):
     def from_json(type_json: dict):
         """Pointer
         {
@@ -282,7 +282,7 @@ def from_json(type_json: dict):
         declaration: str = type_json["declaration"]
         is_function_pointer = "type_details" in type_json
         kind: Kind = Kind.from_json(type_json["description"], is_function_pointer)
-        return DearBindingsTypeNew(declaration, kind)
+        return _Type(declaration, kind)
 
     def __init__(self, declaration: str, kind: Kind):
         self.declaration = declaration

src/model/dear_bindings/db_type.py

@@ -28,12 +28,12 @@ def to_pyi(self) -> str:
         return pythonise_string(self.name_omitted_imgui_prefix()).upper()
 
 
-class DearBindingsEnumNew(IEnum):
+class _Enum(IEnum):
     def from_json(enum_json: dict) -> IEnum:
         name = enum_json["name"]
         elements = [Element.from_json(e) for e in enum_json["elements"]]
         comments = parse_comment(enum_json)
-        return DearBindingsEnumNew(name, elements, comments)
+        return _Enum(name, elements, comments)
 
     def __init__(self, name: str, elements: List[IEnumElement], comments: Comments):
         self.name = name

src/model/dear_bindings/enum.py

@@ -2,11 +2,11 @@
 from typing import List
 from ..comments import Comments, parse_comment
 from .interfaces import IFunction, IType, IArgument
-from .db_type import DearBindingsTypeNew
-from .argument import DearBindingsArgumentNew
+from .db_type import _Type
+from .argument import Argument
 
 
-class DearBindingsFunctionNew(IFunction):
+class Function(IFunction):
     def from_json(function_json: dict) -> IFunction:
         """Function
         {
@@ -53,15 +53,15 @@ def from_json(function_json: dict) -> IFunction:
         },
         """
         name: str = function_json["name"]
-        return_type: IType = DearBindingsTypeNew.from_json(function_json["return_type"])
+        return_type: IType = _Type.from_json(function_json["return_type"])
         # Ignore any Cython unsupported arguments
         arguments: List[IArgument] = []
         for argument in function_json["arguments"]:
             if argument["is_varargs"] or argument.get("type", {}).get("declaration") == "va_list":
                 continue
-            arguments.append(DearBindingsArgumentNew.from_json(argument))
+            arguments.append(Argument.from_json(argument))
         comments: Comments = parse_comment(function_json)
-        return DearBindingsFunctionNew(name, return_type, arguments, comments)
+        return Function(name, return_type, arguments, comments)
 
     def __init__(self, name: str, return_type: IType, arguments: List[IArgument], comments: Comments = None):
         self.name = name