statable 3.1.0__py3-none-any.whl

codegen/validate/data/__init__.py

@@ -0,0 +1,30 @@
+# codegen/validate/data/__init__.py
+"""\nValidation data package\n"""
+
+from .validation_rules import VALIDATION_RULES
+from .prompt_templates import (
+    PROMPT_TEMPLATES,
+    FEW_SHOT_EXAMPLE,
+    VALIDATION_POINTS,
+)
+from .action_definitions import (
+    ACTION_DEFINITIONS,
+    format_action_definitions,
+)
+from .keywords import (
+    IGNORE_KEYWORDS,
+    MARKERS,
+    PARSE_KEYWORDS,
+)
+
+__all__ = [
+    'VALIDATION_RULES',
+    'PROMPT_TEMPLATES',
+    'FEW_SHOT_EXAMPLE',
+    'VALIDATION_POINTS',
+    'ACTION_DEFINITIONS',
+    'format_action_definitions',
+    'IGNORE_KEYWORDS',
+    'MARKERS',
+    'PARSE_KEYWORDS',
+]

codegen/validate/data/action_definitions.py

@@ -0,0 +1,200 @@
+# codegen/validate/data/action_definitions.py
+"""
+Action definitions (data only).
+
+[v1.6 change]
+  - Extended the type enum of add_state to 7 kinds (matching StateType)
+  - Added remove_role_function
+
+[v2.2 §12-6 change]
+  - Added 7 cell-level AI actions:
+      add_cell / remove_cell
+      add_action_step / remove_action_step
+      add_transition_relation / remove_transition_relation
+      set_early_return
+"""
+
+ACTION_DEFINITIONS = {
+    'set_initial': {
+        'description': 'Set initial state',
+        'params': {
+            'state': {'type': 'str', 'required': True, 'description': 'State name'},
+        },
+    },
+    'add_transition': {
+        'description': 'Add transition',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'target': {'type': 'str', 'required': True, 'description': 'Target'},
+            'condition': {'type': 'str', 'required': False, 'description': 'Condition'},
+            'action_name': {'type': 'str', 'required': False, 'description': 'Action name'},
+        },
+    },
+    'add_state': {
+        'description': 'Add state',
+        'params': {
+            'name': {'type': 'str', 'required': True, 'description': 'State name'},
+            'type': {
+                'type': 'enum',
+                'required': False,
+                'values': [
+                    'NORMAL', 'CONCURRENT', 'REGION', 'INITIAL',
+                    'FINAL', 'CHOICE', 'JUNCTION',
+                ],
+                'description': 'State type',
+            },
+            'description': {'type': 'str', 'required': False, 'description': 'Description'},
+        },
+    },
+    'add_event': {
+        'description': 'Add event',
+        'params': {
+            'name': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'kind': {'type': 'enum', 'required': False,
+                     'values': ['SIGNAL', 'CALL', 'TIME', 'CHANGE'],
+                     'description': 'Event kind'},
+            'description': {'type': 'str', 'required': False, 'description': 'Description'},
+        },
+    },
+    'remove_transition': {
+        'description': 'Delete transition',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'target': {'type': 'str', 'required': True, 'description': 'Target'},
+        },
+    },
+    'update_transition': {
+        'description': 'Update transition',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'new_target': {'type': 'str', 'required': False, 'description': 'New target'},
+            'new_condition': {'type': 'str', 'required': False, 'description': 'New condition'},
+            'new_action': {'type': 'str', 'required': False, 'description': 'New action'},
+        },
+    },
+    'add_role_function': {
+        'description': 'Add role function',
+        'params': {
+            'name': {'type': 'str', 'required': True, 'description': 'Function name'},
+            'return_type': {'type': 'str', 'required': True, 'description': 'Return type'},
+            'description': {'type': 'str', 'required': False, 'description': 'Description'},
+        },
+    },
+    'remove_role_function': {
+        'description': 'Delete role function',
+        'params': {
+            'name': {'type': 'str', 'required': True,
+                     'description': 'Function name (bare name or namespace.name)'},
+        },
+    },
+    'add_variable': {
+        'description': 'Add variable',
+        'params': {
+            'name': {'type': 'str', 'required': True, 'description': 'Variable name'},
+            'type': {'type': 'str', 'required': True, 'description': 'Type'},
+            'group': {'type': 'str', 'required': False, 'description': 'Group'},
+            'description': {'type': 'str', 'required': False, 'description': 'Description'},
+        },
+    },
+    'add_flag': {
+        'description': 'Add flag',
+        'params': {
+            'name': {'type': 'str', 'required': True, 'description': 'Flag name'},
+            'min_value': {'type': 'int', 'required': False, 'description': 'Min value'},
+            'max_value': {'type': 'int', 'required': False, 'description': 'Max value'},
+            'group': {'type': 'str', 'required': False, 'description': 'Group'},
+        },
+    },
+    # ==============================================================
+    # v2.2 §12-6: Cell-level AI actions
+    # ==============================================================
+    'add_cell': {
+        'description': 'Add (or ensure) a cell for (source, event)',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source state name'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name (empty for completion)'},
+        },
+    },
+    'remove_cell': {
+        'description': 'Remove a cell (actions + relations) for (source, event)',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source state name'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name (empty for completion)'},
+        },
+    },
+    'add_action_step': {
+        'description': 'Add a Pre/Post action step to a cell',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source state name'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'role_function': {'type': 'str', 'required': True, 'description': 'Role function name'},
+            'trigger': {
+                'type': 'enum',
+                'required': False,
+                'values': ['before_transitions', 'after_transitions'],
+                'description': 'Action trigger (default: before_transitions)',
+            },
+        },
+    },
+    'remove_action_step': {
+        'description': 'Remove a Pre/Post action step from a cell',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source state name'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'role_function': {'type': 'str', 'required': True, 'description': 'Role function name'},
+        },
+    },
+    'add_transition_relation': {
+        'description': 'Add a transition relation (group / sequential / exclusive)',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source state name'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'kind': {
+                'type': 'enum',
+                'required': True,
+                'values': ['sequential', 'exclusive', 'group'],
+                'description': 'Relation kind',
+            },
+            'members': {'type': 'list', 'required': True, 'description': 'Transition labels (e.g. ["T1","T2"])'},
+            'shared_condition': {'type': 'str', 'required': False,
+                                 'description': 'Required for kind == "group"'},
+        },
+    },
+    'remove_transition_relation': {
+        'description': 'Remove a transition relation by kind + shared_condition',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source state name'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'kind': {'type': 'str', 'required': True, 'description': 'Relation kind'},
+            'shared_condition': {'type': 'str', 'required': False,
+                                 'description': 'Match shared_condition (optional)'},
+        },
+    },
+    'set_early_return': {
+        'description': 'Set early_return (Commit) flag on a transition',
+        'params': {
+            'source': {'type': 'str', 'required': True, 'description': 'Source state name'},
+            'event': {'type': 'str', 'required': True, 'description': 'Event name'},
+            'label': {'type': 'str', 'required': True, 'description': 'Transition label (e.g. "T1")'},
+            'early_return': {'type': 'bool', 'required': True,
+                             'description': 'True = Commit, False = Tentative'},
+        },
+    },
+}
+
+
+def format_action_definitions() -> str:
+    """Convert action definitions to prompt text."""
+    lines = ["[Available actions]"]
+    for i, (action, definition) in enumerate(ACTION_DEFINITIONS.items(), 1):
+        params = definition['params']
+        param_strs = []
+        for key, param in params.items():
+            required = "Required" if param['required'] else "Optional"
+            param_strs.append(f'"{key}": {param["description"]}({required})')
+        lines.append(f"{i}. {action}: {definition['description']}")
+        lines.append(f"   params: {{{', '.join(param_strs)}}}")
+    return '\n'.join(lines)

codegen/validate/data/keywords.py

@@ -0,0 +1,46 @@
+# codegen/validate/data/keywords.py
+"""\nKeyword definitions (data only)\n"""
+
+IGNORE_KEYWORDS = {
+    'greeting': ['Understood', 'Understood', 'Understood', 'Yes,', 'Hello'],
+    'preface': ['Below', 'Analysis result', 'Validated', 'Confirmed', 'The following is'],
+    'explanation': ['is', 'does', 'Considering', 'I think', 'is.'],
+    'supplement': ['Note,', 'By the way', 'For reference', 'Supplement'],
+    'closing': ['That is all', 'The above is', 'Please confirm', 'Best regards'],
+}
+
+MARKERS = {
+    'primary': {
+        'start': '---CHANGES_START---',
+        'end': '---CHANGES_END---',
+    },
+    'alternatives': [
+        {'start': '```json', 'end': '```'},
+        {'start': '```JSON', 'end': '```'},
+        {'start': '<<<CHANGES_START>>>', 'end': '<<<CHANGES_END>>>'},
+        {'start': '[[CHANGES_START]]', 'end': '[[CHANGES_END]]'},
+        {'start': '===CHANGES_START===', 'end': '===CHANGES_END==='},
+    ],
+}
+
+PARSE_KEYWORDS = {
+    'severity': {
+        'error': ['ERROR', 'Error', 'Critical'],
+        'warning': ['WARNING', 'Warning'],
+        'info': ['INFO', 'Info'],
+    },
+    'category': {
+        'state': ['State'],
+        'event': ['Event'],
+        'transition': ['Transition'],
+        'role_function': ['Role function', 'Function'],
+        'variable': ['Variable'],
+        'flag': ['Flag'],
+        'queue': ['Queue'],
+        'interrupt': ['Interrupt'],
+        'timer': ['Timer'],
+        'custom_type': ['Type', 'Struct'],
+    },
+    'suggestion': ['Fix method', 'Fix proposal', 'Proposal', 'Corresponds', 'Solution'],
+    'target': ['Target', 'State', 'Function', 'Variable', 'Event'],
+}

codegen/validate/data/prompt_templates.py

@@ -0,0 +1,176 @@
+# codegen/validate/data/prompt_templates.py
+"""
+Prompt template definitions (data only)
+
+[v2.8.0 / SPEC_AI_PROMPT_v1.1]
+  Full refresh of the diagnosis prompt:
+    - XML-style tag structure (system/workflow/task/...)
+    - Two few-shot examples (basic + evidence-based)
+    - Explicit <output_schema> and <response_format>
+    - Evidence / confidence / priority fields documented
+    - Backward-compatible parser fallback still accepts the
+      legacy <json> marker and the plain { ... } form.
+"""
+
+# ======================================================================
+# Output schema (passed as a format argument, so braces need no escape)
+# ======================================================================
+OUTPUT_SCHEMA = """{
+  "version": "1.0",
+  "summary": "<one-line overview, optional>",
+  "changes": [
+    {
+      "id": "C-001",
+      "action": "<one of the allowed actions>",
+      "params": { "<param-name>": "<value>" },
+      "reason": "<why this change is needed>",
+      "evidence": ["<validation code or identifier>"],
+      "priority": "high|medium|low",
+      "confidence": 0.0
+    }
+  ]
+}"""
+
+
+# ======================================================================
+# Few-shot example 1: basic changes (set_initial + add_transition)
+# ======================================================================
+FEW_SHOT_EXAMPLE_1 = """{
+  "version": "1.0",
+  "summary": "Set the missing initial state and add an error recovery transition.",
+  "changes": [
+    {
+      "id": "C-001",
+      "action": "set_initial",
+      "params": { "state": "INIT" },
+      "reason": "Initial state is not set.",
+      "evidence": ["STATE_NO_INITIAL"],
+      "priority": "high",
+      "confidence": 0.95
+    },
+    {
+      "id": "C-002",
+      "action": "add_transition",
+      "params": {
+        "source": "ERROR",
+        "event": "RESET",
+        "target": "IDLE",
+        "action_name": "ResetError"
+      },
+      "reason": "No error recovery transition from the error state.",
+      "evidence": ["STATE_NO_TRANSITION:ERROR"],
+      "priority": "high",
+      "confidence": 0.90
+    }
+  ]
+}"""
+
+
+# ======================================================================
+# Few-shot example 2: removal with multiple evidence items
+# ======================================================================
+FEW_SHOT_EXAMPLE_2 = """{
+  "version": "1.0",
+  "summary": "Remove the transition to the unreachable Halt state.",
+  "changes": [
+    {
+      "id": "C-001",
+      "action": "remove_transition",
+      "params": {
+        "source": "Idle",
+        "event": "STOP",
+        "target": "Halt"
+      },
+      "reason": "Halt is unreachable because no state can reach it.",
+      "evidence": [
+        "STATE_UNREACHABLE:Halt",
+        "TRANSITION_DEAD_END:Idle-STOP-Halt"
+      ],
+      "priority": "medium",
+      "confidence": 0.75
+    }
+  ]
+}"""
+
+
+# ======================================================================
+# Main template
+# ======================================================================
+PROMPT_TEMPLATES = {
+    'diagnosis': {
+        'template': """<system>
+You are an expert in embedded software state transition design.
+Your task is to diagnose a state machine design and propose minimal,
+correct, and safe changes.
+</system>
+
+<workflow>
+You are part of a semi-automatic design-improvement loop:
+validation -> your proposal -> user review -> apply -> re-validate.
+Your output is a PROPOSAL, not an automatic change.
+Prefer minimal, evidence-based changes that a human can trust.
+If no change is needed, return an empty "changes" array.
+</workflow>
+
+<task>
+Diagnose the state machine design shown in <context> using the
+internal validation results in <validation>. Propose minimal, safe
+changes as JSON that conform to <output_schema>.
+</task>
+
+<output_schema>
+{output_schema}
+</output_schema>
+
+<examples>
+<example id="1">
+{example_1}
+</example>
+
+<example id="2">
+{example_2}
+</example>
+</examples>
+
+<constraints>
+- Output ONLY the JSON inside <response>...</response> tags.
+- Do NOT invent new state names, event names, or role function names
+  unless explicitly required by an error.
+- For every change, provide evidence (validation code or state/event name).
+- Prefer minimal changes: one logical fix per change item.
+- Set "version" to "1.0" exactly.
+</constraints>
+
+<context>
+{context}
+</context>
+
+<validation>
+{validation}
+</validation>
+
+<actions>
+{actions}
+</actions>
+
+<response_format>
+Output exactly ONE JSON object wrapped in <response>...</response> tags.
+No text, no markdown fences, no explanations outside the tags.
+</response_format>
+""",
+    },
+}
+
+
+# Legacy constants kept for backward compatibility with older code
+# that imports them. They are not used by the new template.
+FEW_SHOT_EXAMPLE = FEW_SHOT_EXAMPLE_1
+
+VALIDATION_POINTS = """[Validation points]
+1. Is the initial state set?
+2. Are transitions defined for all states?
+3. Is there a recovery transition from the error state?
+4. Are all events that each state should handle covered?
+5. Are there any unreachable states?
+6. Is there any possibility of deadlock?
+"""

codegen/validate/data/validation_rules.py

@@ -0,0 +1,205 @@
+# codegen/validate/data/validation_rules.py
+"""Validation rule definitions (data only)."""
+
+VALIDATION_RULES = {
+    'state': {
+        'STATE_NO_INITIAL': {
+            'severity': 'error',
+            'message': 'Initial state is not set',
+            'suggestion': 'Please set initial state with set_initial()',
+        },
+        'STATE_UNREACHABLE': {
+            'severity': 'warning',
+            'message': 'State "{name}" is unreachable',
+            'suggestion': 'Add a transition or delete the state',
+        },
+        'STATE_NO_TRANSITION': {
+            'severity': 'warning',
+            'message': 'State "{name}" has no outgoing transition',
+            'suggestion': 'Add a transition or mark this as a terminal state',
+        },
+        'STATE_DUPLICATE': {
+            'severity': 'warning',
+            'message': 'State names "{name}" and "{other}" differ in case',
+            'suggestion': 'Please unify the naming convention',
+        },
+    },
+    'event': {
+        'EVENT_UNUSED': {
+            'severity': 'warning',
+            'message': 'Event "{name}" is not used',
+            'suggestion': 'Add a transition or delete the event',
+        },
+        'EVENT_NO_TRANSITION': {
+            'severity': 'warning',
+            'message': 'No transition defined for event "{name}"',
+            'suggestion': 'Please add a transition',
+        },
+    },
+    'transition': {
+        'TRANSITION_TARGET_UNDEFINED': {
+            'severity': 'error',
+            'message': 'Target "{target}" is not defined',
+            'suggestion': 'Please define the target state',
+        },
+        'TRANSITION_EVENT_UNDEFINED': {
+            'severity': 'error',
+            'message': 'Event "{event}" is not defined',
+            'suggestion': 'Please define the event',
+        },
+        'TRANSITION_SOURCE_UNDEFINED': {
+            'severity': 'error',
+            'message': 'Source "{source}" is not defined',
+            'suggestion': 'Please define the source state',
+        },
+        'TRANSITION_DUPLICATE': {
+            'severity': 'warning',
+            'message': 'Transition "{source} --[{event}]--> {target}" is duplicated',
+            'suggestion': 'Please delete the duplicate transition',
+        },
+        'TRANSITION_SELF_LOOP': {
+            'severity': 'info',
+            'message': 'Self transition "{source} --[{event}]--> {source}"',
+            'suggestion': 'Please confirm whether the self transition is intentional',
+        },
+    },
+    'role_function': {
+        'ROLE_FUNC_NO_RETURN_TYPE': {
+            'severity': 'error',
+            'message': 'Role function "{name}" has no return type defined',
+            'suggestion': 'Please set the return type',
+        },
+        'ROLE_FUNC_ARG_MISMATCH': {
+            'severity': 'error',
+            'message': 'Role function "{name}" has incomplete argument definitions',
+            'suggestion': 'Please set argument names and types correctly',
+        },
+        'ROLE_FUNC_UNUSED': {
+            'severity': 'warning',
+            'message': 'Role function "{name}" is not used',
+            'suggestion': 'Please use it or delete it',
+        },
+    },
+    'variable': {
+        'VAR_DUPLICATE_NAME': {
+            'severity': 'error',
+            'message': 'Variable name "{name}" is duplicated',
+            'suggestion': 'Please change the variable name',
+        },
+        'VAR_INVALID_TYPE': {
+            'severity': 'warning',
+            'message': 'Variable "{name}" has invalid type "{type}"',
+            'suggestion': 'Please specify a valid type',
+        },
+        'VAR_INVALID_ARRAY_SIZE': {
+            'severity': 'error',
+            'message': 'Variable "{name}" has an invalid array size',
+            'suggestion': 'Array size must be greater than 0',
+        },
+    },
+    'flag': {
+        'FLAG_DUPLICATE_NAME': {
+            'severity': 'error',
+            'message': 'Flag name "{name}" is duplicated',
+            'suggestion': 'Please change the flag name',
+        },
+        'FLAG_INVALID_RANGE': {
+            'severity': 'warning',
+            'message': 'Flag "{name}" has invalid range',
+            'suggestion': 'min_value <= max_value required',
+        },
+    },
+    'queue': {
+        'QUEUE_INVALID_SIZE': {
+            'severity': 'error',
+            'message': 'Queue "{name}" has an invalid size',
+            'suggestion': 'Size must be greater than 0',
+        },
+        'QUEUE_UNDEFINED_EVENT': {
+            'severity': 'warning',
+            'message': 'Queue "{name}" contains undefined events',
+            'suggestion': 'Please confirm the event definitions',
+        },
+    },
+    'interrupt': {
+        'INTERRUPT_DUPLICATE_NAME': {
+            'severity': 'error',
+            'message': 'Interrupt name "{name}" is duplicated',
+            'suggestion': 'Please change the interrupt name',
+        },
+        'INTERRUPT_UNDEFINED_EVENT': {
+            'severity': 'warning',
+            'message': 'Interrupt "{name}" contains undefined events',
+            'suggestion': 'Please confirm the event definitions',
+        },
+    },
+    'timer': {
+        'TIMER_DUPLICATE_VARIABLE': {
+            'severity': 'error',
+            'message': 'Timer variable "{name}" duplicates an existing variable',
+            'suggestion': 'Please change the variable name',
+        },
+        'TIMER_INVALID_MULTIPLIER': {
+            'severity': 'error',
+            'message': 'Timer "{name}" has an invalid multiplier',
+            'suggestion': 'Multiplier must be > 0',
+        },
+    },
+    'custom_type': {
+        'TYPE_DUPLICATE_NAME': {
+            'severity': 'error',
+            'message': 'Type name "{name}" is duplicated',
+            'suggestion': 'Please change the type name',
+        },
+        'TYPE_NO_MEMBERS': {
+            'severity': 'warning',
+            'message': 'Type "{name}" has no members defined',
+            'suggestion': 'Please add a member',
+        },
+    },
+    # ==============================================================
+    # v2.2: cell-level validation rules
+    # ==============================================================
+    'cell': {
+        'CELL_EMPTY_CONDITION': {
+            'severity': 'warning',
+            'message': 'Transition has no condition and no target (no-op)',
+            'suggestion': 'Remove the no-op transition or add a condition/target',
+        },
+        'CELL_DUPLICATE_LABEL': {
+            'severity': 'error',
+            'message': 'Duplicate transition label "{label}"',
+            'suggestion': 'Assign a unique label to each transition',
+        },
+        'CELL_DANGLING_RELATION': {
+            'severity': 'error',
+            'message': 'Relation references missing label "{label}"',
+            'suggestion': 'Fix the relation members or add the referenced transition',
+        },
+        'CELL_UNREACHABLE_TRANSITION': {
+            'severity': 'warning',
+            'message': 'Transition "{label}" is unreachable',
+            'suggestion': 'Remove it or adjust the preceding Commit transition',
+        },
+        'CELL_OVERLAP_POSSIBLE': {
+            'severity': 'warning',
+            'message': 'Two transitions share condition "{condition}"',
+            'suggestion': 'Differentiate the conditions or merge the transitions',
+        },
+        'CELL_DUPLICATE_TARGET': {
+            'severity': 'info',
+            'message': 'Multiple transitions target "{target}"',
+            'suggestion': 'Confirm whether this is intentional',
+        },
+        'CELL_EXCLUSIVE_NO_RETURN': {
+            'severity': 'info',
+            'message': 'Exclusive member "{label}" lacks early_return=True',
+            'suggestion': 'Enable early_return to enforce mutual exclusion',
+        },
+        'CELL_EMPTY_TARGET': {
+            'severity': 'warning',
+            'message': 'Transition "{label}" has no target and no early_return',
+            'suggestion': 'Set a target or enable early_return',
+        },
+    },
+}