From 69f62cdf6d491fe8bd472d7b8ff1266f4e5668ed Mon Sep 17 00:00:00 2001
From: Gwilherm Baudic <gbaudic@users.noreply.github.com>
Date: Wed, 13 Nov 2024 20:39:10 +0100
Subject: [PATCH] Add PasswordField widget

---
 SConstruct                               |  1 +
 include/guisan.hpp                       |  1 +
 include/guisan/widgets/passwordfield.hpp | 99 ++++++++++++++++++++++++
 src/SConscript                           |  1 +
 src/widgets/passwordfield.cpp            | 93 ++++++++++++++++++++++
 5 files changed, 195 insertions(+)
 create mode 100644 include/guisan/widgets/passwordfield.hpp
 create mode 100644 src/widgets/passwordfield.cpp

diff --git a/SConstruct b/SConstruct
index ade8d19..cb45b86 100644
--- a/SConstruct
+++ b/SConstruct
@@ -112,6 +112,7 @@ widget_headers = [
     'include/guisan/widgets/label.hpp',
     'include/guisan/widgets/listbox.hpp',
     'include/guisan/widgets/messagebox.hpp',
+    'include/guisan/widgets/passwordfield.hpp',
     'include/guisan/widgets/progressbar.hpp',
     'include/guisan/widgets/radiobutton.hpp',
     'include/guisan/widgets/scrollarea.hpp',
diff --git a/include/guisan.hpp b/include/guisan.hpp
index 65aba43..6673257 100644
--- a/include/guisan.hpp
+++ b/include/guisan.hpp
@@ -102,6 +102,7 @@
 #include <guisan/widgets/label.hpp>
 #include <guisan/widgets/listbox.hpp>
 #include <guisan/widgets/messagebox.hpp>
+#include <guisan/widgets/passwordfield.hpp>
 #include <guisan/widgets/progressbar.hpp>
 #include <guisan/widgets/scrollarea.hpp>
 #include <guisan/widgets/slider.hpp>
diff --git a/include/guisan/widgets/passwordfield.hpp b/include/guisan/widgets/passwordfield.hpp
new file mode 100644
index 0000000..f3affd1
--- /dev/null
+++ b/include/guisan/widgets/passwordfield.hpp
@@ -0,0 +1,99 @@
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004, 2005, 2006, 2007 Olof Naessén and Per Larsson
+ *
+ *                                                         Js_./
+ * Per Larsson a.k.a finalman                          _RqZ{a<^_aa
+ * Olof Naessén a.k.a jansem/yakslem                _asww7!uY`>  )\a//
+ *                                                 _Qhm`] _f "'c  1!5m
+ * Visit: http://guichan.darkbits.org             )Qk<P ` _: :+' .'  "{[
+ *                                               .)j(] .d_/ '-(  P .   S
+ * License: (BSD)                                <Td/Z <fP"5(\"??"\a.  .L
+ * Redistribution and use in source and          _dV>ws?a-?'      ._/L  #'
+ * binary forms, with or without                 )4d[#7r, .   '     )d`)[
+ * modification, are permitted provided         _Q-5'5W..j/?'   -?!\)cam'
+ * that the following conditions are met:       j<<WP+k/);.        _W=j f
+ * 1. Redistributions of source code must       .$%w\/]Q  . ."'  .  mj$
+ *    retain the above copyright notice,        ]E.pYY(Q]>.   a     J@\
+ *    this list of conditions and the           j(]1u<sE"L,. .   ./^ ]{a
+ *    following disclaimer.                     4'_uomm\.  )L);-4     (3=
+ * 2. Redistributions in binary form must        )_]X{Z('a_"a7'<a"a,  ]"[
+ *    reproduce the above copyright notice,       #}<]m7`Za??4,P-"'7. ).m
+ *    this list of conditions and the            ]d2e)Q(<Q(  ?94   b-  LQ/
+ *    following disclaimer in the                <B!</]C)d_, '(<' .f. =C+m
+ *    documentation and/or other materials      .Z!=J ]e []('-4f _ ) -.)m]'
+ *    provided with the distribution.          .w[5]' _[ /.)_-"+?   _/ <W"
+ * 3. Neither the name of Guichan nor the      :$we` _! + _/ .        j?
+ *    names of its contributors may be used     =3)= _f  (_yQmWW$#(    "
+ *    to endorse or promote products derived     -   W,  sQQQQmZQ#Wwa]..
+ *    from this software without specific        (js, \[QQW$QWW#?!V"".
+ *    prior written permission.                    ]y:.<\..          .
+ *                                                 -]n w/ '         [.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT       )/ )/           !
+ * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY         <  (; sac    ,    '
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,               ]^ .-  %
+ * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF            c <   r
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR            aga<  <La
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          5%  )P'-3L
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR        _bQf` y`..)a
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,          ,J?4P'.P"_(\?d'.,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES               _Pa,)!f/<[]/  ?"
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT      _2-..:. .r+_,.. .
+ * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     ?a.<%"'  " -'.a_ _,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                     ^
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+ * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef GCN_PASSWORDFIELD_HPP
+#define GCN_PASSWORDFIELD_HPP
+
+#include "guisan/keylistener.hpp"
+#include "guisan/mouselistener.hpp"
+#include "guisan/platform.hpp"
+#include "guisan/widget.hpp"
+#include "guisan/widgets/textfield.hpp"
+
+#include <string>
+
+namespace gcn
+{
+    /**
+     * A text field in which you can write or display a line of text. 
+	 * Unlike a TextField the text will appear as '*' instead of the real content. 
+	 * If for some reason the Font you are using does not contain this character, the 
+	 * PasswordField will be filled by spaces. 
+     */
+    class GCN_CORE_DECLSPEC PasswordField:
+        public TextField
+    {
+    public:
+        /**
+         * Default constructor.
+         */
+        PasswordField();
+
+        /**
+         * Constructor. Initializes the passwordfield with a given string.
+         *
+         * @param text the initial text.
+         */
+        PasswordField(const std::string& text);
+
+        // Inherited from Widget
+
+        void draw(Graphics* graphics) override;
+
+    };
+}
+
+#endif // end GCN_PASSWORDFIELD_HPP
diff --git a/src/SConscript b/src/SConscript
index 67a863d..175cde9 100644
--- a/src/SConscript
+++ b/src/SConscript
@@ -44,6 +44,7 @@ widget_sources = [
 	'widgets/label.cpp',
 	'widgets/listbox.cpp',
 	'widgets/messagebox.cpp',
+	'widgets/passwordfield.cpp',
 	'widgets/progressbar.cpp',
 	'widgets/radiobutton.cpp',
 	'widgets/scrollarea.cpp',
diff --git a/src/widgets/passwordfield.cpp b/src/widgets/passwordfield.cpp
new file mode 100644
index 0000000..8d97a80
--- /dev/null
+++ b/src/widgets/passwordfield.cpp
@@ -0,0 +1,93 @@
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004, 2005, 2006, 2007 Olof Naessén and Per Larsson
+ *
+ *                                                         Js_./
+ * Per Larsson a.k.a finalman                          _RqZ{a<^_aa
+ * Olof Naessén a.k.a jansem/yakslem                _asww7!uY`>  )\a//
+ *                                                 _Qhm`] _f "'c  1!5m
+ * Visit: http://guichan.darkbits.org             )Qk<P ` _: :+' .'  "{[
+ *                                               .)j(] .d_/ '-(  P .   S
+ * License: (BSD)                                <Td/Z <fP"5(\"??"\a.  .L
+ * Redistribution and use in source and          _dV>ws?a-?'      ._/L  #'
+ * binary forms, with or without                 )4d[#7r, .   '     )d`)[
+ * modification, are permitted provided         _Q-5'5W..j/?'   -?!\)cam'
+ * that the following conditions are met:       j<<WP+k/);.        _W=j f
+ * 1. Redistributions of source code must       .$%w\/]Q  . ."'  .  mj$
+ *    retain the above copyright notice,        ]E.pYY(Q]>.   a     J@\
+ *    this list of conditions and the           j(]1u<sE"L,. .   ./^ ]{a
+ *    following disclaimer.                     4'_uomm\.  )L);-4     (3=
+ * 2. Redistributions in binary form must        )_]X{Z('a_"a7'<a"a,  ]"[
+ *    reproduce the above copyright notice,       #}<]m7`Za??4,P-"'7. ).m
+ *    this list of conditions and the            ]d2e)Q(<Q(  ?94   b-  LQ/
+ *    following disclaimer in the                <B!</]C)d_, '(<' .f. =C+m
+ *    documentation and/or other materials      .Z!=J ]e []('-4f _ ) -.)m]'
+ *    provided with the distribution.          .w[5]' _[ /.)_-"+?   _/ <W"
+ * 3. Neither the name of Guichan nor the      :$we` _! + _/ .        j?
+ *    names of its contributors may be used     =3)= _f  (_yQmWW$#(    "
+ *    to endorse or promote products derived     -   W,  sQQQQmZQ#Wwa]..
+ *    from this software without specific        (js, \[QQW$QWW#?!V"".
+ *    prior written permission.                    ]y:.<\..          .
+ *                                                 -]n w/ '         [.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT       )/ )/           !
+ * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY         <  (; sac    ,    '
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,               ]^ .-  %
+ * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF            c <   r
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR            aga<  <La
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          5%  )P'-3L
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR        _bQf` y`..)a
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,          ,J?4P'.P"_(\?d'.,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES               _Pa,)!f/<[]/  ?"
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT      _2-..:. .r+_,.. .
+ * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     ?a.<%"'  " -'.a_ _,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                     ^
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+ * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * For comments regarding functions please see the header file.
+ */
+
+#include "guisan/widgets/passwordfield.hpp"
+
+#include "guisan/font.hpp"
+#include "guisan/graphics.hpp"
+#include "guisan/key.hpp"
+#include "guisan/mouseinput.hpp"
+#include "guisan/text.hpp"
+
+namespace gcn
+{
+    PasswordField::PasswordField() : TextField()
+    {
+
+    }
+
+    PasswordField::PasswordField(const std::string& text) : TextField(text)
+    {
+
+    }
+
+
+    void PasswordField::draw(Graphics* graphics)
+    {
+        std::string encodedText(mText->getRow(0).size(), '*');
+        std::string realText(mText->getRow(0));
+        
+        // Switch replacement text before drawing it to hide it
+        mText->setRow(0, encodedText);
+        TextField::draw(graphics);
+        mText->setRow(0, realText);
+    }
+
+}