/**************************************************************************/
/*                                                                        */
/* Copyright (c) 2001, 2011 NoMachine (http://www.nomachine.com)          */
/* Copyright (c) 2008-2017 Oleksandr Shneyder <o.shneyder@phoca-gmbh.de>  */
/* Copyright (c) 2011-2022 Mike Gabriel <mike.gabriel@das-netzwerkteam.de>*/
/* Copyright (c) 2014-2019 Mihai Moldovan <ionic@ionic.de>                */
/* Copyright (c) 2014-2022 Ulrich Sibiller <uli42@gmx.de>                 */
/* Copyright (c) 2015-2016 Qindel Group (http://www.qindel.com)           */
/*                                                                        */
/* NXAGENT, NX protocol compression and NX extensions to this software    */
/* are copyright of the aforementioned persons and companies.             */
/*                                                                        */
/* Redistribution and use of the present software is allowed according    */
/* to terms specified in the file LICENSE which comes in the source       */
/* distribution.                                                          */
/*                                                                        */
/* All rights reserved.                                                   */
/*                                                                        */
/* NOTE: This software has received contributions from various other      */
/* contributors, only the core maintainers and supporters are listed as   */
/* copyright holders. Please contact us, if you feel you should be listed */
/* as copyright holder, as well.                                          */
/*                                                                        */
/**************************************************************************/

#ifndef __Atoms_H__
#define __Atoms_H__

#include "X.h"
#include "../../include/window.h"
#include "screenint.h"

#define NXAGENT_NUMBER_OF_ATOMS 24

extern Atom nxagentAtoms[NXAGENT_NUMBER_OF_ATOMS];

extern Bool nxagentWMIsRunning;

/*
 * Create the required atoms internally to the agent server.
 */

void nxagentInitAtoms();

/*
 * Query and create all the required atoms on the remote X server
 * using a single round trip.
 */

int nxagentQueryAtoms(ScreenPtr pScreen);

void nxagentResetAtomMap(void);

void nxagentFreeAtomMap(void);

void nxagentWMDetect(void);

#ifdef XlibAtom

/*
 * only provide these prototypes if the including file knows about Xlib
 * types. This allows us including Atoms.h without having to use the
 * Xlib type magic of Agent.h
 */

/*
 * Create the atoms on the remote X server
 * and cache the couple local-remote atoms.
 */

XlibAtom nxagentMakeAtom(char *, unsigned, Bool);

/*
 * Converts local atoms to remote atoms and vice-versa.
 */

Atom nxagentRemoteToLocalAtom(XlibAtom);
XlibAtom nxagentLocalToRemoteAtom(Atom);

/*
 * return the string belonging to an atom. String MUST NOT
 * be freed by the caller!
 */
const char *nxagentRemoteAtomToString(XlibAtom remote);

/*
 * supply two macros that also validate the output.
 */
#define NameForLocalAtom(_atom) validateString(NameForAtom(_atom))
#define NameForRemoteAtom(_xlibatom) validateString(nxagentRemoteAtomToString(_xlibatom))

#endif /* XlibAtom */

#endif /* __Atoms_H__ */