Skip to content

feat(c++): add field validation options for cpp generator #4032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pastoray wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(c++): add field validation options for cpp generator #4032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion compiler/fory_compiler/frontend/fdl/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import warnings
from typing import List, Set, Optional, Tuple
from fory_compiler.ir.validator import ValidationRule

from fory_compiler.ir.ast import (
Schema,
Expand Down Expand Up @@ -77,7 +78,7 @@
"thread_safe_pointer",
"weak_ref",
"java_array",
}
} | { rule.value for rule in ValidationRule }

KNOWN_REF_OPTIONS: Set[str] = {
"weak",
Expand Down
200 changes: 199 additions & 1 deletion compiler/fory_compiler/generators/cpp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
Schema,
)
from fory_compiler.ir.types import PrimitiveKind
from fory_compiler.ir.validator import ValidationRule


class CppGenerator(CppServiceGeneratorMixin, BaseGenerator):
Expand Down Expand Up @@ -901,6 +902,200 @@ def generate_bytes_methods(self, class_name: str, indent: str) -> List[str]:
lines.append(f"{indent}}}")
return lines

def generate_validator(self) -> List[str]:
lines: List[str] = []
lines.append(f"namespace Validator {{")
for message in self.schema.messages:
lines.extend(self.generate_message_validation(message, 0, []))
for union in self.schema.unions:
lines.extend(self.generate_union_validation(union, 0, []))
lines.append(f"}} // namespace Validator")
return lines

def _validation_access(self, message: Message, field: Field, stack: List[Message]) -> Tuple[Optional[str], str]:
"""Return (guard, value) for accessing a field's value inside the validator."""
fname = self.get_field_identifier(message, field)
is_msg = self.is_message_type(field.field_type, stack)
weak_ref = self.get_field_weak_ref(field)

if is_msg and weak_ref:
return (f"if (auto p = obj.{fname}().upgrade())", "*p")
if is_msg and field.ref:
return (f"if (obj.{fname}())", f"*obj.{fname}()")
if is_msg or field.optional:
return (f"if (obj.has_{fname}())", f"obj.{fname}()")
return (None, f"obj.{fname}()")


def generate_message_validation(self, message: Message, indent: int, stack: List[Message]) -> List[str]:
email_pattern = R"(^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$)"
lines: List[str] = []
lines.append(self.indent(f"namespace {message.name} {{", indent))

stack.append(message)
for nested in message.nested_messages:
lines.extend(self.generate_message_validation(nested, indent + 1, stack))
for nested in message.nested_unions:
lines.extend(self.generate_union_validation(nested, indent + 1, stack))
stack.pop()

lines.append(self.indent(f"bool validate(const ::{self.get_namespaced_type_name(message.name, stack)}& obj) {{", indent + 1))
lines.append(self.indent(f"bool ok = true;", indent + 2))

for field in message.fields:
field_name = self.get_field_identifier(message, field)
guard, value = self._validation_access(message, field, stack + [message])
resolved = self.resolve_named_type(field.field_type.name, stack + [message]) if isinstance(field.field_type, NamedType) else None
if isinstance(resolved, Message) or isinstance(resolved, Union):
nested_id = self.get_type_identifier(resolved)
if guard:
lines.append(self.indent(f"{guard} {{ ok &= {nested_id}::validate({value}); }}", indent + 2))
else:
lines.append(self.indent(f"ok &= {nested_id}::validate({value});", indent + 2))
option_lines: List[str] = []
for key, rule_val in field.options.items():
try:
rule = ValidationRule(key)
except ValueError:
continue
if rule == ValidationRule.GTE:
option_lines.append(self.indent(f"ok &= ({value} >= {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.LTE:
option_lines.append(self.indent(f"ok &= ({value} <= {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.GT:
option_lines.append(self.indent(f"ok &= ({value} > {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.LT:
option_lines.append(self.indent(f"ok &= ({value} < {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.EQL:
option_lines.append(self.indent(f"ok &= ({value} == {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.NEQ:
option_lines.append(self.indent(f"ok &= ({value} != {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.MIN_LEN:
option_lines.append(self.indent(f"ok &= ({value}.size() >= {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.MAX_LEN:
option_lines.append(self.indent(f"ok &= ({value}.size() <= {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.PATTERN:
option_lines.append(self.indent(f"static const std::regex re_{field_name}(R\"({rule_val})\");", indent + 3 if guard else indent + 2))
option_lines.append(self.indent(f"ok &= (std::regex_match({value}, re_{field_name}));", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.EMAIL and rule_val:
option_lines.append(self.indent(f"static const std::regex re_{field_name}(R\"({email_pattern})\");", indent + 3 if guard else indent + 2))
option_lines.append(self.indent(f"ok &= (std::regex_match({value}, re_{field_name}));", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.UUID and rule_val:
i3 = indent + 3 if guard else indent + 2
option_lines.append(self.indent(f"ok &= ({value}.size() == 36);", i3))
option_lines.append(self.indent(f"if ({value}.size() == 36) {{", i3))
option_lines.append(self.indent(f"for (size_t i = 0; i < 36; i++) {{", i3 + 1))
option_lines.append(self.indent(f"if (i == 8 || i == 13 || i == 18 || i == 23) {{", i3 + 2))
option_lines.append(self.indent(f"ok &= ({value}[i] == '-');", i3 + 3))
option_lines.append(self.indent(f"}} else {{", i3 + 2))
option_lines.append(self.indent(
f"ok &= (std::isxdigit(static_cast<unsigned char>({value}[i])));",
i3 + 3
))
option_lines.append(self.indent(f"}}", i3 + 2))
option_lines.append(self.indent(f"}}", i3 + 1))
option_lines.append(self.indent(f"}}", i3))
elif rule == ValidationRule.MIN_ITEMS:
option_lines.append(self.indent(f"ok &= ({value}.size() >= {rule_val});", indent + 3 if guard else indent + 2))
elif rule == ValidationRule.MAX_ITEMS:
option_lines.append(self.indent(f"ok &= ({value}.size() <= {rule_val});", indent + 3 if guard else indent + 2))

if option_lines:
if guard:
lines.append(self.indent(f"{guard} {{", indent + 2))
lines.extend(option_lines)
lines.append(self.indent(f"}}", indent + 2))
else:
lines.extend(option_lines)

lines.append(self.indent(f"return ok;", indent + 2))
lines.append(self.indent(f"}}", indent + 1))
lines.append(self.indent(f"}} // namespace {message.name}", indent))
return lines

def generate_union_validation(self, union: Union, indent: int, stack: List[Message]) -> List[str]:
email_pattern = R"(^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$)"
lines: List[str] = []
lines.append(self.indent(f"namespace {union.name} {{", indent))
lines.append(self.indent(
f"bool validate(const ::{self.get_namespaced_type_name(union.name, stack)}& obj) {{",
indent + 1
))
lines.append(self.indent(f"bool ok = true;", indent + 2))

for field in union.fields:
field_name = self.get_union_case_identifier(union, field)
value = f"obj.{field_name}()"
guard = f"if (obj.is_{field_name}())"

case_lines: List[str] = []
resolved = self.resolve_named_type(field.field_type.name, stack) if isinstance(field.field_type, NamedType) else None
if isinstance(resolved, Message):
nested_id = self.get_type_identifier(resolved)
case_lines.append(self.indent(f"ok &= {nested_id}::validate({value});", indent + 3))

for key, rule_val in field.options.items():
try:
rule = ValidationRule(key)
except ValueError:
continue
if rule == ValidationRule.GTE:
case_lines.append(self.indent(f"ok &= ({value} >= {rule_val});", indent + 3))
elif rule == ValidationRule.LTE:
case_lines.append(self.indent(f"ok &= ({value} <= {rule_val});", indent + 3))
elif rule == ValidationRule.GT:
case_lines.append(self.indent(f"ok &= ({value} > {rule_val});", indent + 3))
elif rule == ValidationRule.LT:
case_lines.append(self.indent(f"ok &= ({value} < {rule_val});", indent + 3))
elif rule == ValidationRule.EQL:
case_lines.append(self.indent(f"ok &= ({value} == {rule_val});", indent + 3))
elif rule == ValidationRule.NEQ:
case_lines.append(self.indent(f"ok &= ({value} != {rule_val});", indent + 3))
elif rule == ValidationRule.MIN_LEN:
case_lines.append(self.indent(f"ok &= ({value}.size() >= {rule_val});", indent + 3))
elif rule == ValidationRule.MAX_LEN:
case_lines.append(self.indent(f"ok &= ({value}.size() <= {rule_val});", indent + 3))
elif rule == ValidationRule.PATTERN:
case_lines.append(self.indent(f"static const std::regex re_{field_name}(R\"({rule_val})\");", indent + 3))
case_lines.append(self.indent(
f"ok &= (std::regex_match({value}, re_{field_name}));",
indent + 3
))
elif rule == ValidationRule.EMAIL and rule_val:
case_lines.append(self.indent(f"static const std::regex re_{field_name}(R\"({email_pattern})\");", indent + 3))
case_lines.append(self.indent(
f"ok &= (std::regex_match({value}, re_{field_name}));",
indent + 3
))
elif rule == ValidationRule.UUID and rule_val:
case_lines.append(self.indent(f"ok &= ({value}.size() == 36);", indent + 3))
case_lines.append(self.indent(f"if ({value}.size() == 36) {{", indent + 3))
case_lines.append(self.indent(f"for (size_t i = 0; i < 36; i++) {{", indent + 4))
case_lines.append(self.indent(f"if (i == 8 || i == 13 || i == 18 || i == 23) {{", indent + 5))
case_lines.append(self.indent(f"ok &= ({value}[i] == '-');", indent + 6))
case_lines.append(self.indent(f"}} else {{", indent + 5))
case_lines.append(self.indent(
f"ok &= (std::isxdigit(static_cast<unsigned char>({value}[i])));",
indent + 6
))
case_lines.append(self.indent(f"}}", indent + 5))
case_lines.append(self.indent(f"}}", indent + 4))
case_lines.append(self.indent(f"}}", indent + 3))
elif rule == ValidationRule.MIN_ITEMS:
case_lines.append(self.indent(f"ok &= ({value}.size() >= {rule_val});", indent + 3))
elif rule == ValidationRule.MAX_ITEMS:
case_lines.append(self.indent(f"ok &= ({value}.size() <= {rule_val});", indent + 3))

if case_lines:
lines.append(self.indent(f"{guard} {{", indent + 2))
lines.extend(case_lines)
lines.append(self.indent(f"}}", indent + 2))

lines.append(self.indent(f"return ok;", indent + 2))
lines.append(self.indent(f"}}", indent + 1))
lines.append(self.indent(f"}} // namespace {union.name}", indent))
return lines

def generate_header(self) -> GeneratedFile:
"""Generate a C++ header file with all types."""
lines = []
Expand All @@ -918,9 +1113,11 @@ def generate_header(self) -> GeneratedFile:
includes.add("<unordered_map>")
includes.add("<vector>")
includes.add("<utility>")
includes.add("<regex>")
includes.add("<cctype>")
includes.add("<cstddef>")
includes.add('"fory/serialization/fory.h"')
if self.schema_has_unions():
includes.add("<cstddef>")
includes.add("<utility>")
includes.add("<variant>")
includes.add("<memory>")
Expand Down Expand Up @@ -1013,6 +1210,7 @@ def generate_header(self) -> GeneratedFile:
lines.extend(self.generate_registration())
lines.append("")

lines.extend(self.generate_validator())
if namespace:
lines.append(f"}} // namespace {namespace}")
lines.append("")
Expand Down
Loading
Loading