content-metainformation-md-untemplate.scala

// DO NOT HAND EDIT -- Autogenerated from 'content-metainformation.md.untemplate' at 2024-06-18T04:04:27.471909Z
package untemplatedoc.readme.functionaltemplates

import java.io.{Writer,StringWriter}
import scala.collection.{immutable,mutable}

import untemplatedoc.*
import java.nio.file.Files
import com.mchange.codegenutil.*



val Untemplate_content_metainformation_md = new untemplate.Untemplate[Int,SubsectionMeta]:
  val UntemplateFunction                    : untemplate.Untemplate[Int,SubsectionMeta] = this
  val UntemplateName                        : String = "content_metainformation_md"
  val UntemplatePackage                     : String = "untemplatedoc.readme.functionaltemplates"
  val UntemplateInputName                   : String = "level"
  val UntemplateInputTypeDeclared           : String = "Int"
  val UntemplateInputTypeCanonical          : Option[String] = untemplate.Macro.nonEmptyStringOption( untemplate.Macro.recursiveCanonicalName[Int] )
  val UntemplateInputDefaultArgument        : Option[Int] = (None : Option[Int])
  val UntemplateOutputMetadataTypeDeclared  : String = "SubsectionMeta"
  val UntemplateOutputMetadataTypeCanonical : Option[String] = untemplate.Macro.nonEmptyStringOption( untemplate.Macro.recursiveCanonicalName[SubsectionMeta] )
  val UntemplateHeaderNote                  : String = "This is a header note."
  val UntemplateLastModified                : Option[Long] = Some(1718683459518L)
  val UntemplateSynthetic                   : Boolean = false

  val UntemplateAttributes = immutable.Map (
    "Tags"    -> immutable.Set("Boring", "Useful"),
    "PubDate" -> "2023-02-12"
  )

  def apply(level : Int) : untemplate.Result[SubsectionMeta] =
    val writer             : StringWriter = new StringWriter(37790)
    val attrs              : immutable.Map[String,Any] = UntemplateAttributes
    var mbMetadata         : Option[SubsectionMeta] = None
    var outputTransformer  : Function1[untemplate.Result[SubsectionMeta],untemplate.Result[SubsectionMeta]] = readme.subsection_content_transformer_md


    val title = "Metainformation"
    mbMetadata = Some( SubsectionMeta( level, title ) )


      val block0 = new Function0[String]:
        def apply() : String =
          "\nWithin an untemplate, you have access to variables containing metainformation about the generated function.\n\nIt may be useful to use `UntemplateFunction` as a Map key, in order to decorate it with metadata.\nBeyond that, if this will be useful at all, it will probably be for debugging.\n\nFor the [untemplate you are reading](" + ( readmeMetainformationSrc ) +
          ") [[generated scala](" + ( sgenFor("untemplatedoc/readme/functionaltemplates/content-metainformation.md.untemplate") ) +
          ")]:\n\n```\nUntemplateFunction:                      " + (UntemplateFunction) +
          "\nUntemplateName:                         \"" + (UntemplateName) +
          "\"\nUntemplatePackage:                      \"" + (UntemplatePackage) +
          "\"\nUntemplateFullyQualifiedName:           \"" + (UntemplateFullyQualifiedName) +
          "\"\nUntemplateInputTypeDeclared:            \"" + (UntemplateInputTypeDeclared) +
          "\"\nUntemplateInputTypeCanonical:            " + (UntemplateInputTypeCanonical) +
          "\nUntemplateInputDefaultArgument:          " + (UntemplateInputDefaultArgument) +
          "\nUntemplateOutputMetadataTypeDeclared:   \"" + (UntemplateOutputMetadataTypeDeclared) +
          "\"\nUntemplateOutputMetadataTypeCanonical:   " + (UntemplateOutputMetadataTypeCanonical) +
          "\nUntemplateHeaderNote:                   \"" + (UntemplateHeaderNote) +
          "\"\nUntemplateLastModified:                  " + (UntemplateLastModified) +
          " // milliseconds into UNIX epoch\nUntemplateSynthetic:                     " + (UntemplateSynthetic) +
          " // set to true if you implement by hand the trait untemplate. an untemplate transpiled in the usual way from the source documented here is NOT synthetic.\nUntemplateAttributes:                    " + (UntemplateAttributes) +
          "\nUntemplateAttributesLowerCased:          " + (UntemplateAttributesLowerCased) +
          "\n```\n\n`UntemplateFunction` is a reference to the `Untemplate` (which is a subtype of `Function1`) that implements your untemplate.\n\n\"Declared\" type values are just `String`, and names _may not be fully qualified_.\n\n\"Canonical\" types are, if possible, resolved to fully qualified type names that look through (non-opaque) aliases.\nHowever, for some types such resolution may not be possible, so these are `Option[String]`\n\n`UntemplateInputDefaultArgument` is an `Option[T]` where `T` is the input type and the value is `Some(defaultInputArg)`\nif one was defined or `None` otherwise.\n\nFor more on header notes, see [below](#long-delimiters-header-notes-and-comments).\n\nUntemplates can define custom [attributes](#attributes) for themselves as an `immutable.Map[String,Any]`.\n\n" + ( box(None, Some("Note"))( """All untemplates import `scala.collection.*`, so `immutable.Map[String,Any]` is a name in scope.""" ) ) +
          "\n\nBecause it's often convenient to resolve attributes in a case-independent way, untemplates also\noffer an `immutable.Map[LowerCased,Any]`, where `LowerCased` is an opaque type representing\na lowercased `String`. For example,\n\n```scala\nimport untemplate.LowerCased\n\nval pubDateKey = LowerCased(\"PubDate\")\nval mbPubDate = myUntemplate.UntemplateAttributesLowerCased.get(pubDateKey)\n```\n\nUntemplate metadata is available not only within your untemplates. Each untemplate\nbecomes becomes an `untemplate.Untemplate` object, on which all the metadata\nfields are available as public vals. If you have an untemplate called\n`mypkg.hello_md`, there will be an `untemplate.Untemplate` object called\n`mypkg.Untemplate_hello_md`, so you can write, e.g.\n\n```scala\nval helloHeaderNote = mypkg.Untemplate_hello_md.UntemplateHeaderNote\n```\n\nThis can be particularly useful in combination with [indexing](#indexing).\n"
      writer.write(block0())

    outputTransformer( untemplate.Result( mbMetadata, writer.toString ) )

  end apply
end Untemplate_content_metainformation_md

def content_metainformation_md(level : Int) : untemplate.Result[SubsectionMeta] = Untemplate_content_metainformation_md( level )