Merge branch 'codewithnick:main' into main

Author: avi-dey

.github/issue-assigner.yml

@@ -0,0 +1,43 @@
+# Remove or comment the line from yml if you don't need that feature
+
+# The name of bot you would like to be mentioned by users. {name} will be replaced by the below name
+name: "ASCII_BOT"
+
+######################## Issue assignment ########################
+
+# Prompt entered by user to request assign the issue to him/her
+assign-prompt: "@{name} claim" # For example, @issue-assigner claim
+
+# Comment from bot if the issue got already assigned to the user requesting
+issue-already-assigned: "You have already been assigned to this issue."
+
+# Maximum number of assignees for an issue
+max-assignees: 1
+
+# Maximum number of assignees reached for the requested issue
+max-assignees-reached: "Sorry, maximum limit for assignees in this issue has reached. Please check other issues or contact a maintainer."
+
+# Maximum number of open issues a user can have assigned at a time in the repo
+max-issues-for-user: 4
+
+# If all OK, the comment from bot to tell that issue got assigned
+assigned-comment: "This issue has been successfully assigned to you! 🚀"
+
+######################## Issue un-assignment ########################
+
+# Prompt entered by user to request un-assignment of the issue to him/her
+unassign-prompt: "@{name} abandon"
+
+# If the issue was already not assigned to the user
+issue-was-not-assigned: "You were not assigned to this issue."
+
+# If criteria is matched, the issue will get un-assigned
+unassigned-comment: "You have been unassigned to this issue successfully."
+
+######################## Issue Opened ########################
+
+# If the user who opened issue is NOT a maintainer of the repo
+issue-opener-not-maintainer: "Thank you for opening this issue. You can wait for a discusssion with maintainers or Comment '@{name} claim' to get this issue assigned or '@{name} abandon' to get this issue unassigned."
+
+# If the user who opened issue IS a maintainer of the repo
+issue-opener-is-maintainer: "Comment '@{name} claim' to get this issue assigned or '@{name} abandon' to get this issue unassigned."

.github/workflows/main.yml

@@ -16,4 +16,4 @@ jobs:
           readme_path: readme.md
           image_size: 70
           use_username: true
-          columns_per_row: 7
+          columns_per_row: 6

.gitignore

@@ -6,3 +6,5 @@
 .vscode
 .\test.cpp
 CharGen
+example.cpp
+example

Ascii.h

@@ -4,13 +4,19 @@
 #define ASCII_H
 
 #include <string>
+#include <memory>
 #include "./Fonts/fonts.h"
 #include "./Fonts/SevenStar/sevenstar.h"
 #include "./Fonts/Boomer/boomer.h"
 #include "./Fonts/Straight/straight.h"
 #include "./Fonts/starwar/starwar.h"
-#include "./Fonts/Carlos/carlos.h"
+#include "./Fonts/carlos/carlos.h"
 #include "./Fonts/banner/banner.h"
+#include "./Fonts/block/block.h"
+#include "./Fonts/amongus/amongus.h"
+#include "./Fonts/drpepper/drpepper.h"
+#include "./Fonts/small/small.h"
+#include "./Fonts/3d-diagonal/3d-diagonal.h"
 
 namespace ascii
 {
@@ -21,58 +27,82 @@ namespace ascii
         straight,
         starwar,
         carlos,
-        banner
+        banner,
+        block,
+        amongus,
+        drpepper,
+        small,
+        threeD_diagonal
     };
 
     class Ascii
     {
 
     public:
-        // std::string fontName;
-        Fonts *font;
+        std::unique_ptr<Fonts> font;
         Ascii(const FontName &fontName)
         {
-            // std::cout<<"initialised ascii";
             if (fontName == FontName::sevenstar)
             {
-                // std::cout<<"initialised sevenstar";
-                this->font = new SevenStar();
+                this->font.reset(new SevenStar());
             }
             else if (fontName == FontName::boomer)
             {
-                // std::cout<<"initialised sevenstar";
-                this->font = new Boomer();
+                this->font.reset(new Boomer());
             }
             else if (fontName == FontName::straight)
             {
-
-                this->font = new Straight();
+                this->font.reset(new Straight());
             }
             else if (fontName == FontName::starwar)
             {
-                this->font = new Starwar();
+                this->font.reset(new Starwar());
             }
             else if (fontName == FontName::carlos)
             {
-                this->font = new Carlos();
+                this->font.reset(new Carlos());
             }
             else if (fontName == FontName::banner)
             {
-                // std::cout<<"initialised sevenstar";
-                this->font = new Banner();
+                this->font.reset(new Banner());
+            }
+            else if (fontName == FontName::block)
+            {
+                this->font.reset(new Block());
+            }
+            else if (fontName == FontName::amongus)
+            {
+                this->font.reset(new Amongus());
+            }
+            else if (fontName == FontName::drpepper)
+            {
+                this->font.reset(new Drpepper());
+            }
+            else if (fontName == FontName::small)
+            {
+                this->font.reset(new Small());
+            }
+            else if (fontName == FontName::threeD_diagonal)
+            {
+                this->font.reset(new ThreeD_Diagonal());
             }
             else
             {
                 exit(500);
             }
         }
-        void print(const std::string &text)
+        
+
+        void reset()
         {
+            font->resetMatrix();
+        }
 
-            char **character = nullptr;
-            // std::cout<<"printing";
+        void print(const std::string &text)
+        {
+            vs character;
 
-            for (int i = 0; i < text.size(); i++)
+            for (size_t i = 0; i < text.size(); i++)
             {
                 char c = text[i];
 
@@ -206,14 +236,14 @@ namespace ascii
                 else if (c == '9')
                     character = font->nine();
 
-                //for space
+                // for space
                 else if (c == ' ')
                     character = font->space();
 
                 font->pushChar(character);
             }
             font->printvector();
-            // font->destroyspace();
+            font->resetMatrix();
         }
     };
 } // namespace ascii

CONTRIBUTING.md

@@ -2,27 +2,46 @@
 
 Changes and improvements are more than welcome! ❤ Feel free to fork and open a pull request.
 
+To read The Technical aspects you might want to refer [This](./Documentation/Structure.md)
+
 Please consider the following :
 
 1. Fork it!
-2. Add your new features
-   - To add a new font visit [here](#font)
-   - To add a new character visit [here](#new-char)
+2. Open an issue, if it does not already exist (Example: Add char 'A' in DrPepper Font) and ask to get assigned.
+3. Add your new features
+   - To add a new font visit [here](#add-a-new-font)
+   - To add a new character visit [here](#add-a-new-char-in-a-font)
+4. Update README.md (if needed)
+5. Add Screenshots of your working file
+6. Send us a pull request.
+
+## Things you can do
+
+### Improve The Documentation
+
+Good Documentation is a Base for every code base , if you feel there is something missing , not clear in the docs or code needs more comments or can be made prettier, or ever if you find a typo, You can Contribute to Documentation.
+
+1. Open an issue and mention the possible areas of improvement.
+2. Wait for discussion with maintainers and get assigned.
+3. Improve the documentation and send us a new Pull Request.
+
+### Report/Fix a Bad Character in a Font
 
-3. Update README.md (if needed)
-4. Submit a pull request.
+1. Open a new issue and post screenshots of the terminal.
+2. Mention the font and character which has a problem.
+3. Mention Expected and Actual result
 
-## Font
+### Add a new Font
 
 1. Select a non-duplicate name for font
 2. Copy the fontname directory from templates directory to Fonts directoy. Rename this directory to the name of your font
 3. In that directory, rename the header file and the md file to the name of your font.
 4. Set the specified grid size for your font in the appropriate macro fields.
 5. Now, In "Ascii.h" #include your font
-6. then, Add the condition of your font in the if else block
-7. Add some previews to the md file. 
+6. Then, Add the condition of your font in the if else block
+7. Add some previews to the md file.
 
-## New-Char
+### Add a New-Char in a Font
 
 1. Select a character which is not previously used in a font
 2. In your selected font's header file uncomment the respective function.

Documentation/Structure.md

@@ -0,0 +1,54 @@
+# This file contains the abstract working of the codebase
+
+## Structure
+
+### Font class:
+
+It is the parent of all font classes (amongus,drpepper,etc) all other font classes inherit attributes and methods from this class , the virtual functions are overridden in the child classes and are triggered on runtime using runtime polymorphism.
+
+##### Attributes and Methods:
+
+###### Private:
+
+`vector<vector<char>> letters;`
+2D vector to store the characters in each of the font
+This vector is what is actually printed on the screen
+
+`unsigned int def_rows;`
+Total number of rows in the font
+`unsigned int def_cols;`
+Total number of columns in the font
+`unsigned int char_rows;`
+The row size of each character in the font
+`unsigned int char_cols;`
+The column size of each character in the font
+`unsigned int curr_col;`
+The current position of the column in the font,
+Keeping track of this helps us insert new characters into the letters vector
+
+###### Protected:
+`char **getCharGrid(unsigned int rows = 0, unsigned int cols = 0)`
+return a 2D character grid of size `rows` and `cols` with each `char=' '`, which can be overwritten later, basically helps in creating new memory space for characters
+
+###### Public:
+
+`Fonts::Fonts(int def_rows, int def_cols)`
+
+This constructor initializes the rows and columns of the font
+and fills the vector `this.letter` with spaces
+
+`void printvector()`
+
+This function dumps the 2D vector `this.letter` on the screen
+
+`void pushchar(**character)`
+
+This function pushes a character into the 2D vector `this.letter` at the current column `curr_col` position
+
+**All Virtual functions:**
+These are to be overwriten in the child classes as each letter will be different in each font, each function is supposed to return a 2D character grid of the respective character
+virtual functions include:
+`virtual char **a()` to `virtual char **z()`
+`virtual char **A()` to `virtual char **Z()`
+`virtual char **Zero()` to `virtual char **Nine()`
+`virtual char **space()`