This repository has been archived on 2021-04-17. You can view files and clone it, but cannot push or open issues or pull requests.
uIRC/src/assemblers/assemblers.h

48 lines
1.7 KiB
C
Raw Normal View History

/*
* This file is part of uIRC. (https://git.redxen.eu/caskd/uIRC)
* Copyright (c) 2019, 2020 Alex-David Denes
*
* uIRC 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, either version 3 of the License, or
* any later version.
*
* uIRC 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 uIRC. If not, see <https://www.gnu.org/licenses/>.
*/
/*! \file */
#include "../types.h" // IRC_User IRC_Message
#include <stdbool.h> // bool
#include <stddef.h> // size_t
#ifndef UIRC_GUARD_PUBLIC_ASSEMBLERS
#define UIRC_GUARD_PUBLIC_ASSEMBLERS
signed long uirc_assembler_user(char* buf, IRC_User* u, size_t len);
#ifdef UIRC_FEATURE_IRCV3
signed long uirc_assembler_tag(char* buf, const IRC_Tag* t, size_t len);
#endif /* UIRC_FEATURE_IRCV3*/
/*!
* \brief IRC_Message to string converter
*
* This assembles a IRC_Message struct to a string representation of a most size len
* The return value is either the lenght of the string or any of the uirc_errors errors
* \param[in] m IRC_Message struct that contains at least a command
* \param[in] len Maximum lenght of string
* \param[out] buf String representation of message (if successful)
* \warning in and buf SHOULD NOT be NULL, this will trigger a ASSERT so it's required to check it where needed
*/
signed long uirc_assembler_message(char* buf, IRC_Message* m, size_t len);
#endif /* UIRC_GUARD_PUBLIC_ASSEMBLERS */