version.py

#!/usr/bin/env python

from argparse import ArgumentParser
from git import Repo as GitRepository
from os import getcwd as cwd
from os.path import dirname, realpath
from os.path import join as path

__location__ = realpath(path(cwd(), dirname(__file__)))

if __name__ == "__main__":
    parser = ArgumentParser(description="Generate tree-sitter API version class.")
    parser.add_argument(
        "-o",
        "--output",
        default=path(__location__, "TreeSitter.java"),
        help="Output file path.",
    )
    args = parser.parse_args()
    tree_sitter = path(__location__, "tree-sitter")
    with open(args.output, "w") as output, GitRepository(tree_sitter) as repository:
        commit = repository.head.commit
        tags = [tag for tag in repository.tags if tag.commit == commit]
        output.write(f"""\
/*
 * MIT License
 *
 * Copyright (c) 2022-present SEART Research Group and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package ch.usi.si.seart.treesitter.version;

import lombok.experimental.UtilityClass;

/**
 * Utility used for obtaining the current version of the {{@code tree-sitter}} API.
 *
 * @author Ozren Dabić
 * @since 1.11.0
 */
@UtilityClass
public class TreeSitter {{

    public static final String SHA = \"{commit.hexsha}\";

    public static final String TAG = \"{next((tag.name for tag in tags), "")}\";

    /**
     * Get the current version of {{@code tree-sitter}}.
     *
     * @return the semantic version string, along with a commit SHA
     */
    public String getVersion() {{
        return TAG + \" (\" + SHA + \")\";
    }}
    
    /**
     * The latest ABI version that is supported by the current version of the library.
     * When languages are generated by the {{@code tree-sitter}} CLI, they are assigned
     * an ABI version number that corresponds to the current CLI version.
     *
     * @return current ABI version number
     * @since 1.12.0
     */
    public native int getCurrentABIVersion();

    /**
     * The earliest ABI version that is supported by the current version of the library.
     * The {{@code tree-sitter}} library is generally backwards-compatible with languages
     * generated using older CLI versions, but is not forwards-compatible.
     *
     * @return earliest supported ABI version number
     * @since 1.12.0
     */
    public native int getMinimumABIVersion();
}}
""")