sword_rs/src/cxx/module.h

/*
 * A safe, Rust-native binding for the SWORD library
 * Copyright (C) 2025 Gregory Hellings
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 2.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */
#pragma once

#include <memory>
#include <sword/swmodule.h>
#include <string>

#include "rust/cxx.h"
#include "versekey.h"

namespace sword_rs {
    class Module {
        private:
            sword::SWModule* module;

        public:
            Module(sword::SWModule* module);

            void decrement();

            rust::String get_name() const;

            rust::String get_type() const;

            SwordVerseKey* get_verse_key() const;

            void increment();

            bool is_skip_consecutive_links() const;

            rust::String render_text();

            void set_key_text(const rust::String& keyText);

            void set_skip_consecutive_links(bool skip);

            rust::String strip_text();
    };
}