⚡ Feature: Comment support #171

New Issue

deavmi · 2024-04-15T19:31:48+01:00

deavmi commented

2024-04-15 19:31:48 +01:00

Purpose ✍️

To add support for comments and have them attach to the nearest AST node.

Checklist 🗒️

A CommentParser that understands both /** (multi-line) and // (single-line) comments
The usage and attachment of Comments in the right places at the right times, within the Parser
Allow @<param> to span multiple lines till next 2 is encountered
Parser to maybe use previous-token checks rather than what is on stack, for checking for comments. We need to keep track of prevToken maybe, and then on-demand "Is there a SymbolType.COMMENT in prevToken?".
- If so, then auto-construct a Comment, and return it
- If not, then discard.
- Implement proxying nextToken(), etc. methods (this will store this.prevToken for us)
- Handle stars-and-bars even betters for multi-line comments

# Purpose ✍️ To add support for comments and have them attach to the nearest AST node. ## Checklist 🗒️ - [x] A `CommentParser` that understands both `/**` (multi-line) and `//` (single-line) comments - [ ] The usage and attachment of `Comment`s in the right places at the right times, within the `Parser` - [ ] Allow `@<param>` to span multiple lines **till next `2`** is encountered - [ ] `Parser` to maybe use previous-token checks rather than what is on stack, for checking for comments. We need to keep track of `prevToken` maybe, and then on-demand _"Is there a `SymbolType.COMMENT` in `prevToken`?"_. * If **so**, then auto-construct a `Comment`, and return it * If **not**, then discard. - [x] Implement proxying `nextToken()`, etc. methods (this will store `this.prevToken` for us) - [ ] Handle stars-and-bars even betters for **multi-line** comments

deavmi self-assigned this 2024-04-15 19:31:52 +01:00

deavmi added this to the Parser project 2024-04-15 19:31:56 +01:00

deavmi added this to the Basics milestone 2024-04-15 19:32:02 +01:00

deavmi added the

parser

qol

question

labels 2024-04-15 19:32:07 +01:00

deavmi added the due date 2024-04-30

2024-04-15 19:32:16 +01:00

deavmi started working 2024-04-15 19:39:01 +01:00

deavmi stopped working 2024-04-15 19:40:21 +01:00

1 minute 20 seconds

deavmi added reference feature/comments

2024-04-15 19:41:08 +01:00

deavmi started working 2024-04-15 20:39:08 +01:00

deavmi commented

2024-04-15 20:49:19 +01:00

Working on ther comment sdtack now

deavmi commented

2024-04-15 20:59:34 +01:00

Will continue tomorrow

deavmi stopped working 2024-04-15 21:01:32 +01:00

22 minutes 23 seconds

deavmi started working 2024-04-16 07:18:54 +01:00

deavmi stopped working 2024-04-16 07:36:55 +01:00

18 minutes 1 second

deavmi started working 2024-04-16 09:44:33 +01:00

deavmi commented

2024-04-16 10:23:15 +01:00

Working on the CommentParser now...

Working on the `CommentParser` now...

deavmi commented

2024-04-16 11:36:51 +01:00

CommentParser looks like it is working for multi-line.
Now need to add singl-line support.

`CommentParser` looks like it is working for multi-line. Now need to add singl-line support.

deavmi stopped working 2024-04-16 11:36:54 +01:00

1 hour 52 minutes

deavmi started working 2024-04-16 11:37:18 +01:00

deavmi stopped working 2024-04-16 11:54:32 +01:00

17 minutes 14 seconds

deavmi started working 2024-04-16 16:21:09 +01:00

deavmi commented

2024-04-16 16:56:24 +01:00

Working on parsing things like @param i This is stuff

Working on parsing things like `@param i This is stuff`

deavmi commented

2024-04-16 17:19:50 +01:00

Damn man, why is this such a dogshit implementation. It is so ugly, let me do it propetly:

string buildUp;
        bool foundType = false;
        DocType dType;
        bool foundName;
        string paramName;
        bool inDescr;

        ulong i = 0;
        bool getch(ref char c)
        {
            if(i < line.length)
            {
                c = line[i];
                return true;
            }
            return false;
        }

        void prog()
        {
            i++;
        }

        char c;
        while(getch(c))
        {
            if(c == ' ' && !inDescr)
            {
                prog();
                continue;
            }
            else if(c == '@' && !foundType)
            {
                string paramType;
                prog();
                while(getch(c) && c != ' ')
                {
                    paramType ~= c;
                    prog();
                }

                // TODO: Now validate `name`
                if(paramType == "param")
                {
                    foundType = true;
                    dType = DocType.PARAM;
                }
            }
            else if(!foundName)
            {
                while(getch(c) && c != ' ')
                {
                    paramName ~= c;
                    prog();
                }

                // TODO: check name?
                foundName = true;
            }
            else
            {

            }
        }

Damn man, why is this such a dogshit implementation. It is so ugly, let me do it propetly: ```d string buildUp; bool foundType = false; DocType dType; bool foundName; string paramName; bool inDescr; ulong i = 0; bool getch(ref char c) { if(i < line.length) { c = line[i]; return true; } return false; } void prog() { i++; } char c; while(getch(c)) { if(c == ' ' && !inDescr) { prog(); continue; } else if(c == '@' && !foundType) { string paramType; prog(); while(getch(c) && c != ' ') { paramType ~= c; prog(); } // TODO: Now validate `name` if(paramType == "param") { foundType = true; dType = DocType.PARAM; } } else if(!foundName) { while(getch(c) && c != ' ') { paramName ~= c; prog(); } // TODO: check name? foundName = true; } else { } } ```

deavmi commented

2024-04-16 18:02:20 +01:00

Look at that, doc string parsing!

Look at that, doc string parsing! ![image](/attachments/9bbcfff1-f142-48ad-a4a3-69672c5e0d7b)

deavmi stopped working 2024-04-16 18:02:24 +01:00

1 hour 41 minutes

deavmi started working 2024-04-16 18:02:26 +01:00

deavmi stopped working 2024-04-16 19:12:03 +01:00

1 hour 9 minutes

deavmi started working 2024-04-16 19:30:40 +01:00

deavmi commented

2024-04-16 19:33:38 +01:00

Working on adding support for @returns parsing now...

Working on adding support for `@returns` parsing now...

deavmi commented

2024-04-16 19:49:18 +01:00

Working on adding support for @returns parsing now...

Added ✅

> Working on adding support for `@returns` parsing now... Added ✅

deavmi commented

2024-04-16 20:22:38 +01:00

Working on adding support for @returns parsing now...

Added ✅

Added some fixes here and there

> > Working on adding support for `@returns` parsing now... > > Added ✅ Added some fixes here and there

deavmi commented

2024-04-16 20:23:12 +01:00

Damn man, why is this such a dogshit implementation. It is so ugly, let me do it propetly:

string buildUp;
        bool foundType = false;
        DocType dType;
        bool foundName;
        string paramName;
        bool inDescr;

        ulong i = 0;
        bool getch(ref char c)
        {
            if(i < line.length)
            {
                c = line[i];
                return true;
            }
            return false;
        }

        void prog()
        {
            i++;
        }

        char c;
        while(getch(c))
        {
            if(c == ' ' && !inDescr)
            {
                prog();
                continue;
            }
            else if(c == '@' && !foundType)
            {
                string paramType;
                prog();
                while(getch(c) && c != ' ')
                {
                    paramType ~= c;
                    prog();
                }

                // TODO: Now validate `name`
                if(paramType == "param")
                {
                    foundType = true;
                    dType = DocType.PARAM;
                }
            }
            else if(!foundName)
            {
                while(getch(c) && c != ' ')
                {
                    paramName ~= c;
                    prog();
                }

                // TODO: check name?
                foundName = true;
            }
            else
            {

            }
        }

Tomorrow I will continue. I am also working on it in a nicer refactored parser for now and I am much happier with how the code is looking now.

> Damn man, why is this such a dogshit implementation. It is so ugly, let me do it propetly: > > ```d > string buildUp; > bool foundType = false; > DocType dType; > bool foundName; > string paramName; > bool inDescr; > > ulong i = 0; > bool getch(ref char c) > { > if(i < line.length) > { > c = line[i]; > return true; > } > return false; > } > > void prog() > { > i++; > } > > char c; > while(getch(c)) > { > if(c == ' ' && !inDescr) > { > prog(); > continue; > } > else if(c == '@' && !foundType) > { > string paramType; > prog(); > while(getch(c) && c != ' ') > { > paramType ~= c; > prog(); > } > > // TODO: Now validate `name` > if(paramType == "param") > { > foundType = true; > dType = DocType.PARAM; > } > } > else if(!foundName) > { > while(getch(c) && c != ' ') > { > paramName ~= c; > prog(); > } > > // TODO: check name? > foundName = true; > } > else > { > > } > } > ``` Tomorrow I will continue. I am also working on it in a nicer refactored parser for now and I am much happier with how the code is looking now.

deavmi stopped working 2024-04-16 20:23:16 +01:00

52 minutes 37 seconds

deavmi started working 2024-04-16 20:42:26 +01:00

deavmi stopped working 2024-04-16 20:42:29 +01:00

3 seconds

deavmi added spent time 2024-04-16 20:42:33 +01:00

3 minutes

deavmi started working 2024-04-16 20:42:35 +01:00

deavmi stopped working 2024-04-17 10:42:00 +01:00

13 hours 59 minutes

deavmi started working 2024-04-17 10:42:02 +01:00

deavmi commented