Skip to content
The Chat Archive
o1-preview-2024-09-12· OpenAI WildChat-4.8M (AI2)

Write a function in GDScript for Godot 4, which takes in a markdown text as a String and…

  1. User

    Write a function in GDScript for Godot 4, which takes in a markdown text as a String and returns the same text also as a String, but formatted in bbcode! Please use best practices, like type annotations!

  2. Assistant

    Here's a GDScript function markdown_to_bbcode that converts Markdown-formatted text into BBCode-formatted text. It handles bold, italic, inline code, links, images, and headers. Type annotations are used throughout to follow best practices.

    func markdown_to_bbcode(markdown_text: String) -> String:
        var bbcode_text: String = markdown_text
    
        # Precompile regex patterns for efficiency
        var bold_patterns: Array[RegEx] = []
        for pattern_str in [r'\*\*(.+?)\*\*', r'__(.+?)__']:
            var pattern = RegEx.new()
            pattern.compile(pattern_str)
            bold_patterns.append(pattern)
    
        var italic_patterns: Array[RegEx] = []
        for pattern_str in [r'\*(.+?)\*', r'_(.+?)_']:
            var pattern = RegEx.new()
            pattern.compile(pattern_str)
            italic_patterns.append(pattern)
    
        var code_regex: RegEx = RegEx.new()
        code_regex.compile(r'`([^`]+)`')
    
        var link_regex: RegEx = RegEx.new()
        link_regex.compile(r'\[([^\]]+)\]\(([^\)]+)\)')
    
        var image_regex: RegEx = RegEx.new()
        image_regex.compile(r'!\[([^\]]*)\]\(([^\)]+)\)')
    
        var header_regex: RegEx = RegEx.new()
        header_regex.compile(r'^(#{1,6})\s*(.+)$', RegEx.MULTILINE)
    
        # Replace bold text
        for regex in bold_patterns:
            bbcode_text = regex.substitute(bbcode_text, '[b]$1[/b]', true)
    
        # Replace italic text
        for regex in italic_patterns:
            bbcode_text = regex.substitute(bbcode_text, '[i]$1[/i]', true)
    
        # Replace inline code
        bbcode_text = code_regex.substitute(bbcode_text, '[code]$1[/code]', true)
    
        # Replace links
        bbcode_text = link_regex.substitute(bbcode_text, '[url=$2]$1[/url]', true)
    
        # Replace images
        bbcode_text = image_regex.substitute(bbcode_text, '[img]$2[/img]', true)
    
        # Replace headers
        func header_replacer(match: RegExMatch) -> String:
            var hashes: String = match.get_string(1)
            var level: int = hashes.length()
            var text: String = match.get_string(2).strip_edges()
            var size: int = 32 - (level - 1) * 4  # Adjust size based on header level
            return "[size={}]{}[/size]\n".format(size, text)
    
        bbcode_text = header_regex.substitute(bbcode_text, header_replacer, true)
    
        return bbcode_text
    

    Explanation:

    • Type Annotations: All variables and function parameters/return types are annotated for clarity and to follow best practices.
    • Regex Patterns: Regular expressions are precompiled for efficiency and to avoid recompiling them in loops.
    • Replacement Functions: For headers, a replacement function header_replacer is used to calculate the appropriate size based on the header level.
    • Markdown Elements Handled:
      • Bold: **text** or __text__ → [b]text[/b]
      • Italic: *text* or _text_ → [i]text[/i]
      • Inline Code: `code` → [code]code[/code]
      • Links: [text](url) → [url=url]text[/url]
      • Images: ![alt](url) → [img]url[/img]
      • Headers: # Header to ###### Header → [size]Header[/size] with decreasing size

    Usage Example:

    var markdown_text = """
    # Welcome to **Godot**
    
    This is a *sample* Markdown text with a [link](http://example.com) and an image:
    
    ![Alt Text](image.png)
    
    Here's some `inline code`.
    """
    
    var bbcode_text = markdown_to_bbcode(markdown_text)
    print(bbcode_text)
    

    This function should cover the basic Markdown formatting options and convert them into BBCode format suitable for use in Godot's RichTextLabel or other components that support BBCode.