{"id":628,"date":"2017-02-13T14:19:04","date_gmt":"2017-02-13T14:19:04","guid":{"rendered":"http:\/\/dlang.org\/blog\/?p=628"},"modified":"2021-10-08T11:08:43","modified_gmt":"2021-10-08T11:08:43","slug":"a-new-import-idiom","status":"publish","type":"post","link":"https:\/\/dlang.org\/blog\/2017\/02\/13\/a-new-import-idiom\/","title":{"rendered":"A New Import Idiom"},"content":{"rendered":"

Daniel Nielsen is an Embedded Software Engineer. He is currently using D in his spare time for an unpublished Roguelike and warns that he “may produce bursts of D Evangelism”.<\/em><\/p>\n

\n

\"\"I remember one day in my youth, before the dawn of Internet, telling my teachers about “my” new algorithm, only to learn it had been discovered by the ancient Greeks in ~300 BC. This is the story of my life and probably of many who are reading this. It is easy to “invent” something; being the first, not so much!<\/p>\n

Anyway, this is what all the fuss is about this time:<\/p>\n

template from(string moduleName)\r\n{\r\n  mixin(\"import from = \" ~ moduleName ~ \";\");\r\n}<\/pre>\n
The TL;DR version: A new idiom to achieve even lazier imports.<\/p>\n
Before the C programmers start running for the hills, please forget you ever got burned by C++ templates. The above snippet doesn’t look that complicated, now does it? If you enjoy inventing new abstractions, take my advice and give D a try<\/a>. Powerful, yet an ideal beginner’s language. No need to be a template archwizard.<\/p>\n
Before we proceed further, I’d like to call out Andrei Alexandrescu for identifying that there is a problem which needs solving. Please see his in depth motivation in DIP 1005<\/a>. Many thanks also to Dominikus Dittes Scherkl, who helped trigger the magic spark by making his own counter proposal and questioning if there really is a need to change the language specification in order to obtain Dependency-Carrying Declarations (DIP 1005).<\/p>\n
D, like many modern languages, has a fully fledged module system<\/a> where symbols are directly imported (unlike the infamous C #include<\/code>). This has ultimately resulted in the widespread use of local imports, limiting the scope as much as possible, in preference to the somewhat slower and less maintainable module-level imports:<\/p>\n
\/\/ A module-level import\r\nimport std.datetime;\r\n  \r\nvoid fun(SysTime time)\r\n{\r\n  import std.stdio; \/\/ A local import\r\n  ...\r\n}<\/pre>\n
Similar lazy import idioms are possible in other languages, for instance Python.<\/p>\n
The observant among you might notice that because SysTime<\/code> is used as the type of a function parameter, std.datetime<\/code> must be imported at module level. Which brings us to the point of this blog post (and DIP 1005). How can we get around that?<\/p>\n
void fun(from!\"std.datetime\".SysTime time)\r\n{\r\n  import std.stdio;\r\n  ...\r\n}<\/pre>\n
There you have it, the Scherkl-Nielsen self-important lookup.<\/p>\n
In order to fully understand what’s going on, you may need to learn some D-isms. Let’s break it down.<\/p>\n
    \n
  1. When instantiating a template<\/a> (via the !<\/code> operator), if the TemplateArgument<\/strong> is one token long, the parentheses can be omitted from the template parameters. So from!\"std.datetime\"<\/code> is the same as from!(\"std.datetime\")<\/code>. It may seem trivial, but you’d be surprised how much readability is improved by avoiding ubiquitous punctuation noise.<\/li>\n
  2. Eponymous templates<\/a>. The declaration of a template looks like this:\n
    template y() {\r\n    int x;\r\n}<\/pre>\n
    With that, you have to type y!().x<\/code> in order to reach the int. Oh, ze horror! Is that a smiley? Give me x<\/code> already! That’s exactly what eponymous templates accomplish:<\/p>\n
    template x() {\r\n    int x;\r\n}<\/pre>\n
    Now that the template and its only member have the same name, x!().x<\/code> can be shortened to simply x<\/code>.<\/li>\n
  3. Renamed imports<\/a> allow accessing an imported module via a user-specified namespace. Here, std.stdio<\/code> is imported normally:\n
    void printSomething(string s) {\r\n    import std.stdio;\r\n    writeln(s);           \/\/ The normal way\r\n    std.stdio.writeln(s)  \/\/ An alternative using the fully qualified \r\n                          \/\/ symbol name, for disambiguation\r\n}<\/pre>\n
    Now it’s imported and renamed as io<\/code>:<\/p>\n
    void printSomething(string s) {\r\n    import io = std.stdio;\r\n    io.writeln(s);         \/\/ Must be accessed like this.\r\n    writeln(s);            \/\/ Error\r\n    std.stdio.writeln(s);  \/\/ Error\r\n}<\/pre>\n
    Combining what we have so far:<\/p>\n
    template dt() {\r\n    import dt = std.datetime; \r\n}\r\nvoid fun(dt!().SysTime time) {}<\/pre>\n
    It works perfectly fine. The only thing which remains is to make it generic.<\/li>\n
  4. String concatenation is achieved with the ~<\/code> operator.\n
    string hey = \"Hello,\" ~ \" World!\";\r\nassert(hey == \"Hello, World!\");<\/pre>\n<\/li>\n
  5. String mixins<\/a> put the power of a compiler writer at your fingertips. Let’s generate code at compile time, then compile it. This is typically used for domain-specific languages (see Pegged<\/a> for one prominent use of a DSL in D), but in our simple case we only need to generate one single statement based on the name of the module we want to import. Putting it all together, we get the final form, allowing us to import any symbol from any module inline:\n
    template from(string moduleName)\r\n{\r\n  mixin(\"import from = \" ~ moduleName ~ \";\");\r\n}<\/pre>\n<\/li>\n<\/ol>\n
    In the end, is it all really worth the effort? Using one comparison made by Jack Stouffer:<\/p>\n
    import std.datetime;\r\nimport std.traits;\r\n\r\nvoid func(T)(SysTime a, T value) if (isIntegral!T)\r\n{\r\n    import std.stdio : writeln;\r\n    writeln(a, value);\r\n}<\/pre>\n
    Versus:<\/p>\n
    void func(T)(from!\"std.datetime\".SysTime a, T value)\r\n    if (from!\"std.traits\".isIntegral!T)\r\n{\r\n    import std.stdio : writeln;\r\n    writeln(a, value);\r\n}<\/pre>\n
    In this particular case, the total compilation time dropped to ~30% of the original, while the binary size dropped to ~41% of the original.<\/p>\n
    What about the linker, I hear you cry? Sure, it can remove unused code. But it’s not always as easy as it sounds, in particular due to module constructors (think __attribute__((constructor))<\/code>). In either case, it’s always more efficient to avoid generating unused code in the first place rather than removing it afterwards.<\/p>\n
    So this combination of D features was waiting there to be used, but somehow no one had stumbled on it before. I agreed with the need Andrei identified for Dependency-Carrying Declarations, yet I wanted even more. I wanted Dependency-Carrying Expressions<\/em>. My primary motivation comes from being exposed to way too much legacy C89 code.<\/p>\n
    void foo(void)\r\n{\r\n#ifdef XXX \/* needed to silence unused variable warnings *\/\r\n  int x;\r\n#endif\r\n... lots of code ...\r\n#ifdef XXX\r\n  x = bar();\r\n#endif\r\n}<\/pre>\n
    Variables or modules, in the end they’re all just symbols. For the same reason C99 allowed declaring variables in the middle of functions, one should be allowed to import modules where they are first used. D already allows importing anywhere in a scope, but not in declarations or expressions. It was with this mindset that I saw Dominikus Dittes Scherkl’s snippet<\/a>:<\/p>\n
    fun.ST fun()\r\n{\r\n   import someModule.SomeType;\r\n   alias ST = SomeType;\r\n   ...\r\n}<\/pre>\n
    Clever, yet for one thing it doesn’t adhere to the DRY principle. Still, it was that tiny dot in fun.ST<\/code> which caused the spark. There it was again, the Dependency-Carrying Expression of my dreams.<\/p>\n
    Criteria:<\/p>\n
      \n
    • It must not require repeating fun<\/code>, since that causes problems when refactoring<\/li>\n
    • It must be lazy<\/li>\n
    • It must be possible today with no compiler updates<\/li>\n<\/ul>\n
      Templates are the poster children of lazy constructs; they don’t generate any code until instantiated. So that seemed a good place to start.<\/p>\n
      Typically when using eponymous templates, you would have the template turn into a function, type, variable or alias. But why make the distinction? Once again, they’re all just symbols in the end. We could have used an alias to the desired module (see Scherkl’s snippet above); using the renamed imports feature is just a short-cut for import and alias. Maybe it was this simplified view of modules that made me see more clearly.<\/p>\n
      Now then, is this the only solution? No. As a challenge to the reader, try to figure out what this does and, more importantly, its flaw. Can you fix it?<\/p>\n
      static struct STD\r\n{\r\n  template opDispatch(string moduleName)\r\n  {\r\n    mixin(\"import opDispatch = std.\" ~ moduleName ~ \";\");\r\n  }\r\n}<\/pre>\n
       <\/p>\n","protected":false},"excerpt":{"rendered":"
      Daniel Nielsen is an Embedded Software Engineer. He is currently using D in his spare time for an unpublished Roguelike and warns that he “may produce bursts of D Evangelism”. I remember one day in my youth, before the dawn of Internet, telling my teachers about “my” new algorithm, only to learn it had been […]<\/p>\n","protected":false},"author":14,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[9,20],"tags":[],"_links":{"self":[{"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/posts\/628"}],"collection":[{"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/users\/14"}],"replies":[{"embeddable":true,"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/comments?post=628"}],"version-history":[{"count":26,"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/posts\/628\/revisions"}],"predecessor-version":[{"id":654,"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/posts\/628\/revisions\/654"}],"wp:attachment":[{"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/media?parent=628"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/categories?post=628"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dlang.org\/blog\/wp-json\/wp\/v2\/tags?post=628"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}