jyapayne / nim-extensions

Extensions for the nim programming language.
MIT License
20 stars 4 forks source link

nim-extensions

Extensions for the Nim programming language.

These extensions aim to improve the usability of Nim in practical applications.

Extensions so far include:

OOP macro

This module was modified from the OOP section on the excellent website http://nim-by-example.github.io/

Usage:

  import extensions / oop

  class BaseObject: # inherits from RootObj
    # attributes/properties
    var
      x: int
      y: float

    method override_me(argx: float): int =
      result = int(argx) + self.x

  class ClassName of BaseObject:
      method method_name(arg1: int, arg2: float=0.3): float =
        ## do stuff here
        result = arg2

      method override_me(argx: float): int =
        result = int(self.y) + int(argx) + self.x

There's also an example in the code that demonstrates the inheritance that can be run by executing:

  nim c -r tests/test1.nim

Enumerate

This macro is useful for enumerating on any iterator. It will autodetect which iterator you want to use and give you a useful enumeration.

Usage:

  import os
  import extensions / enumerate

  for i, line in enumerate(lines, "file.txt"):
      echo i, " ", line

  for i, tup in enumerate(walkDir, "."):
      echo i, " ", tup

Objprint

These printing procs are useful for printing objects and their types.

import extensions / objprint

type Unit = ref object
  name: string

echo Unit(name: "Ref")
echo Unit(name: "Non-ref")[]
echo (str: "value")

# Prints:
#  ref Unit(name: "Ref")
#  Unit(name: "Non-ref")
#  tuple[str: string](str: "value")