/*
 * BRLTTY - A background process providing access to the console screen (when in
 *          text mode) for a blind person using a refreshable braille display.
 *
 * Copyright (C) 1995-2026 by The BRLTTY Developers.
 *
 * BRLTTY comes with ABSOLUTELY NO WARRANTY.
 *
 * This is free software, placed under the terms of the
 * GNU Lesser General Public License, as published by the Free Software
 * Foundation; either version 2.1 of the License, or (at your option) any
 * later version. Please see the file LICENSE-LGPL for details.
 *
 * Web Page: http://brltty.app/
 *
 * This software is maintained by Dave Mielke <dave@mielke.cc>.
 */

#ifndef BRLTTY_INCLUDED_CLIPBOARD
#define BRLTTY_INCLUDED_CLIPBOARD

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define CLIPBOARD_LINE_DELIMITER '\n'

typedef struct ClipboardObjectStruct ClipboardObject;

extern ClipboardObject *newClipboard (void);
extern void destroyClipboard (ClipboardObject *cpb);

extern int clearClipboardContent (ClipboardObject *cpb);
extern int truncateClipboardContent (ClipboardObject *cpb, size_t length);

extern int setClipboardContent (ClipboardObject *cpb, const wchar_t *characters, size_t length);
extern int appendClipboardContent (ClipboardObject *cpb, const wchar_t *characters, size_t length);

extern int copyToClipboard (
  ClipboardObject *cpb,
  const wchar_t *characters, size_t length,
  size_t offset, int insertLineDelimiter
);

extern int setClipboardContentUTF8 (ClipboardObject *cpb, const char *text);
extern int appendClipboardContentUTF8 (ClipboardObject *cpb, const char *text);

extern const wchar_t *getClipboardContent (ClipboardObject *cpb, size_t *length);
extern char *getClipboardContentUTF8 (ClipboardObject *cpb);
extern size_t getClipboardContentLength (ClipboardObject *cpb);

static inline int
isClipboardEmpty (ClipboardObject *cpb) {
  return !getClipboardContentLength(cpb);
}

extern int addClipboardHistory (ClipboardObject *cpb, const wchar_t *characters, size_t length);
extern const wchar_t *getClipboardHistory (ClipboardObject *cpb, unsigned int index, size_t *length);

extern ClipboardObject *getMainClipboard (void);
extern void lockMainClipboard (void);
extern void unlockMainClipboard (void);

extern void onMainClipboardUpdated (void);
extern int setMainClipboardContent (const char *content);
extern char *getMainClipboardContent (void);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* BRLTTY_INCLUDED_CLIPBOARD */
