nim-works/nimskull

Clean up `ast.TIdTable` type definition

Open

#145 opened on Dec 31, 2021

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Nim (39 forks)auto 404
good first issuerefactor

Repository metrics

Stars
 (346 stars)
PR merge metrics
 (PR metrics pending)

Description

ast defines TIdTable type that is used in several parts of the semantic pass. Type defined as follows:

  TIdPair* = object
    key*: PIdObj
    val*: RootRef

  TIdPairSeq* = seq[TIdPair]
  TIdTable* = object # the same as table[PIdent] of PObject
    counter*: int
    data*: TIdPairSeq

All the uses of the val: RootRef field are either converted to PType or PSym (result = PType(idTableGet(c.bindings, t)) etc.). This means RootRef can be easily replaced with

type
  PSymOrTyp = object
    case isSym*: bool
      of true:
        sym*: PSym

      of false:
        typ*: PType

This would not create any functional difference, but will clean up the code a little.

Contributor guide

Research direction
Examine the usage of TIdTable in the codebase, particularly the val field. Understand how PType and PSym are used and then replace RootRef with the proposed object variant to statically type the val field.
Tech stack
None
Domain
compilers
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Nim
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70