/* * Copyright (C) 2020 Linux Studio Plugins Project * (C) 2020 Vladimir Sadovnikov * * This file is part of lsp-runtime-lib * Created on: 14 окт. 2019 г. * * lsp-runtime-lib 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 * any later version. * * lsp-runtime-lib 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 lsp-runtime-lib. If not, see . */ #ifndef LSP_PLUG_IN_FMT_BOOKMARKS_H_ #define LSP_PLUG_IN_FMT_BOOKMARKS_H_ #include #include #include #include #include #include #include #define GTK3_BOOKMARK_PATH ".config/gtk-3.0/bookmarks" #define GTK2_BOOKMARK_PATH ".gtk-bookmarks" #define QT5_BOOKMARK_PATH ".local/share/user-places.xbel" #define LNK_BOOKMARK_PATH "Links" namespace lsp { namespace bookmarks { enum bm_origin_t { BM_LSP = 1 << 0, BM_GTK2 = 1 << 1, BM_GTK3 = 1 << 2, BM_QT5 = 1 << 3, BM_LNK = 1 << 4, }; typedef struct bookmark_t { LSPString path; // Path to the directory LSPString name; // Bookmark name size_t origin; // Bookmark origin: LSP, GTK3, QT } bookmark_t; /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param path location of the file in UTF-8 encoding * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_gtk3(lltl::parray *dst, const char *path, const char *charset=NULL); /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_gtk3(lltl::parray *dst, const LSPString *path, const char *charset=NULL); /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_gtk3(lltl::parray *dst, const io::Path *path, const char *charset=NULL); /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param in input character sequence * @return status of operation */ status_t read_bookmarks_gtk3(lltl::parray *dst, io::IInSequence *in); /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param path location of the file in UTF-8 encoding * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_gtk2(lltl::parray *dst, const char *path, const char *charset=NULL); /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_gtk2(lltl::parray *dst, const LSPString *path, const char *charset=NULL); /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_gtk2(lltl::parray *dst, const io::Path *path, const char *charset=NULL); /** * Read GTK3 bookmarks * @param dst list to store bookmarks * @param in input character sequence * @return status of operation */ status_t read_bookmarks_gtk2(lltl::parray *dst, io::IInSequence *in); /** * Read QT5 bookmarks * @param dst list to store bookmarks * @param path location of the file in UTF-8 encoding * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_qt5(lltl::parray *dst, const char *path, const char *charset=NULL); /** * Read QT5 bookmarks * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_qt5(lltl::parray *dst, const LSPString *path, const char *charset=NULL); /** * Read QT5 bookmarks * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks_qt5(lltl::parray *dst, const io::Path *path, const char *charset=NULL); /** * Read QT5 bookmarks * @param dst list to store bookmarks * @param in input character sequence * @return status of operation */ status_t read_bookmarks_qt5(lltl::parray *dst, io::IInSequence *in); /** * Read Windows bookmarks from the specified folder * @param dst destination array to store bookmarks * @param path location of *.lnk files to read bookmarks * @return status of operation */ status_t read_bookmarks_lnk(lltl::parray *dst, const char *path); /** * Read Windows bookmarks from the specified folder * @param dst destination array to store bookmarks * @param path location of *.lnk files to read bookmarks * @return status of operation */ status_t read_bookmarks_lnk(lltl::parray *dst, const LSPString *path); /** * Read Windows bookmarks from the specified folder * @param dst destination array to store bookmarks * @param path location of *.lnk files to read bookmarks * @return status of operation */ status_t read_bookmarks_lnk(lltl::parray *dst, const io::Path *path); /** * Read LSP bookmarks in JSON5 format * @param dst list to store bookmarks * @param path location of the file in UTF-8 encoding * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks(lltl::parray *dst, const char *path, const char *charset=NULL); /** * Read LSP bookmarks in JSON5 format * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks(lltl::parray *dst, const LSPString *path, const char *charset=NULL); /** * Read LSP bookmarks in JSON5 format * @param dst list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t read_bookmarks(lltl::parray *dst, const io::Path *path, const char *charset=NULL); /** * Read LSP bookmarks in JSON5 format * @param dst list to store bookmarks * @param in input character sequence * @return status of operation */ status_t read_bookmarks(lltl::parray *dst, io::IInSequence *in); /** * Save LSP bookmarks in JSON5 format * @param src list to store bookmarks * @param path location of the file in UTF-8 encoding * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t save_bookmarks(const lltl::parray *src, const char *path, const char *charset=NULL); /** * Save LSP bookmarks in JSON5 format * @param src list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t save_bookmarks(const lltl::parray *src, const LSPString *path, const char *charset=NULL); /** * Save LSP bookmarks in JSON5 format * @param src list to store bookmarks * @param path location of the file * @param charset file encoding character set, NULL for default locale * @return status of operation */ status_t save_bookmarks(const lltl::parray *src, const io::Path *path, const char *charset=NULL); /** * Save LSP bookmarks in JSON5 format * @param src list to store bookmarks * @param out output character sequence * @return status of operation */ status_t save_bookmarks(const lltl::parray *src, io::IOutSequence *out); /** * Merge bookmarks: * - add all existing in src bookmarks to dst if they are non-existing in dst * - set origin flag in dst to 'origin' for all bookmarks that exist in dst and origin * - unset origin flsg in dst for all bookmarks that do not exist in src * - remove all bookmarks that have zero origin * @param dst destination storage of bookmarks * @param src source change set * @param origin origin flag associated with source * @param changes pointer to integer to add number of changes * @return status of operation */ status_t merge_bookmarks(lltl::parray *dst, size_t *changes, const lltl::parray *src, bm_origin_t origin); /** * Destroy bookmarks * @param list list of bookmarks */ void destroy_bookmarks(lltl::parray *list); } } #endif /* LSP_PLUG_IN_FMT_BOOKMARKS_H_ */