swad-core/swad_nickname.h

// swad_nickname.h: Users' nicknames

#ifndef _SWAD_NCK
#define _SWAD_NCK
/*
    SWAD (Shared Workspace At a Distance in Spanish),
    is a web platform developed at the University of Granada (Spain),
    and used to support university teaching.

    This file is part of SWAD core.
    Copyright (C) 1999-2024 Antonio Ca<EFBFBD>as Vargas

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
/*****************************************************************************/
/************************* Public types and constants ************************/
/*****************************************************************************/

#define Nck_MIN_CHARS_NICK_WITHOUT_ARROBA	 3	// Example: jim
#define Nck_MAX_CHARS_NICK_WITHOUT_ARROBA	16	// Example: juancarlos_aroja

#define Nck_MAX_BYTES_NICK_WITHOUT_ARROBA	Nck_MAX_CHARS_NICK_WITHOUT_ARROBA
// Several bytes for leading @ because it may come from form
#define Nck_MAX_BYTES_NICK_WITH_ARROBA	(Str_MAX_BYTES_PER_CHAR + Nck_MAX_BYTES_NICK_WITHOUT_ARROBA)

/*****************************************************************************/
/***************************** Public prototypes *****************************/
/*****************************************************************************/

bool Nck_CheckIfNickWithArrIsValid (const char *NickWithArr);

long Nck_GetUsrCodFromNickname (const char *NickWithArr);

void Nck_PutFormToGetNewNickname (const char *NewNickWithoutArr);

void Nck_ShowFormChangeMyNickname (bool IMustFillNickname);
void Nck_ShowFormChangeOtherUsrNickname (void);

void Nck_RemoveMyNick (void);
void Nck_RemoveOtherUsrNick (void);

void Nck_UpdateMyNick (void);
void Nck_ChangeOtherUsrNick (void);

#endif