org.pcre4j.Pcre2CompileContext Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2024 Oleksii PELYKH
 *
 * This file is a part of the PCRE4J. The PCRE4J is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this program. If not, see
 * .
 */
package org.pcre4j;

import org.pcre4j.api.IPcre2;

import java.lang.ref.Cleaner;

public class Pcre2CompileContext {

    private static final Cleaner cleaner = Cleaner.create();

    /**
     * The compile context handle
     */
    /* package-private */ final long handle;

    /**
     * The PCRE2 API reference to use across the entire lifecycle of the object
     */
    /* package-private */ final IPcre2 api;

    /**
     * The cleaner to free the resources
     */
    private final Cleaner.Cleanable cleanable;

    /**
     * Create a new compile context
     *
     * @param generalContext the general context to use or {@code null} to use the default context
     */
    public Pcre2CompileContext(Pcre2GeneralContext generalContext) {
        final var api = Pcre4j.api();

        final var handle = api.compileContextCreate(
                generalContext != null ? generalContext.handle : 0
        );
        if (handle == 0) {
            throw new IllegalStateException("Failed to create compile context");
        }

        this.api = api;
        this.handle = handle;
        this.cleanable = cleaner.register(this, new Pcre2CompileContext.Clean(api, handle));
    }

    /**
     * Get the PCRE2 API backing this compile context
     *
     * @return the PCRE2 API
     */
    public IPcre2 api() {
        return api;
    }

    /**
     * Get the handle of the compile context
     *
     * @return the handle of the compile context
     */
    public long handle() {
        return handle;
    }

    private record Clean(IPcre2 api, long compileContext) implements Runnable {
        @Override
        public void run() {
            api.compileContextFree(compileContext);
        }
    }

}