flutter foundation的_PrefixedStringBuilder

这个从命名上看就知道是diagnostics文件内的一个内部类,并且是一个的前缀字符串建造者(builder)。

构造方法的参数有prefixLineOne, prefixOtherLines和 wrapWidth,其中前两者是必须传的,最后一个是可以不传的。这个类其实和TextTreeConfiguration结合起来看起来特别容易混乱,其实大可不必想那么麻烦。只知道这个类主要承担的功能就是基于前缀的字符串建造者就行。

属性:
  1. prefixLineOne这个公开属性很好理解,就是在添加字符串之前(即第一行)需要添加的前缀。
  2. _prefixOtherLines和_nextPrefixOtherLines,两个即除了第一行,在行开头的前缀。_prefixOtherLines和_nextPrefixOtherLines不同的一点是,如果在添加一行字段的过程之中,调用了incrementPrefixOtherLines方法,_prefixOtherLines是在当前行生效,_nextPrefixOtherLines是在下一行生效。
    3.wrapWidth是定义了多长的字符自动换行的。
  3. _buffer的类型是StringBuffer,存放的是整个字符串建造者全部的数据。
  4. _currentLine的类型也是StringBuffer,存放的就是当前行的全部数据。
  5. _wrappableRanges是list类型,内部是一些整数对,明确了在_currentLine里哪些开始的索引值和结束的索引值形成的块是可以被换行的(wrapped)。
方法:
  1. incrementPrefixOtherLines方法的功能,其实在尚文第二条说的非常清楚了,就不再赘述了
  2. _finalizeLine其实这个是一个核心方法了,只有一个传入参数,就是在行的最后要不要加"\n"。这个做了三件事儿:a. 把_currentLine内容通过调用合适的方法放在_buffer里;b.清楚掉_currentLine内的内容;c.清除掉_wrappableRanges 内的内容。可以从这些看出,这个方法是当前行操作的最后一步。那什么是“合适的方法”,就是_writeLine和_wordWrapLine,会在下面三四条会详细说。
  3. _wordWrapLine需要传入当前行的字符串,可以wrap(换行)的wrapRanges,折叠宽度的width,startOffset其实就是prefixLineOne的值,otherLineOffset其实就是_prefixOtherLines的值。方法功能就是利用wrapRanges和width结合对当前字符串进行处理,在当前字符串大于width,进行手动切分换行。
  4. _writeLine这个方法十分简单,可传入的参数就是一个字符串(line),是否在结尾添加(includeLineBreak),是否是第一行(firstLine),通过这些条件再加上_getCurrentPrefix方法添加后缀还有是否添加换行符来把_currentLine内容写到_buffer中。
  5. 这个build方法是最核心的方法,这个方法很简单,就是通过这个方法取到这个StringBuilder最后的值。
  6. writeRawLines这个方法就是开放给外部调用的,实现很简单,直接强行写入一行。
  7. writeStretched这个方法也是开发给外部调用的,会传入一个目标长度,传入的字符串如果长度不够,就用该字符串的最后一个字符填充。

这个是_PrefixedStringBuilder的完整解读了,_PrefixedStringBuilder是diagnostics的一部分。如有错漏之处,还望斧正。

你可能感兴趣的:(flutter foundation的_PrefixedStringBuilder)