16688 2012-04-10 16:40:11 +0000 Consider rewriting algorithms as full algorithms so variables don't appear as if they're globals 2014-03-27 16:49:43 +0000 1 1 1 Unclassified WHATWG Encoding unspecified PC Windows 3.1 RESOLVED FIXED P2 normal Unsorted 23155 23927 1 annevk annevk jsbell mike pub-w3 simon.sapin sideshowbarker+encodingspec oldest_to_newest 66574 0 annevk 2012-04-10 16:40:11 +0000 Global variables such as "iso-2022-kr state" seem to have unnecessarily long names (shortening, e.g, "euc-kr lead" to "lead" would make it confusingly similar to the local variable "lead", but that can be fixed differently). The use of the definite article with global variables is not consistent. 81332 1 annevk 2013-01-14 11:26:08 +0000 Do you have specifics on incorrect usage of the definite article? That seems like something that should be fixed. 81351 2 pub-w3 2013-01-14 19:42:16 +0000 A clear example of inconsistent (not necessarily incorrect) article usage is ‘set iso-2022-kr state to’ alongside ‘[s]et the iso-2022-kr state to’. More generally, it is not entirely clear why global variables tend to be used with a definite article in phrases like ‘the zxc is initially...’ but not elsewhere. 81386 3 annevk 2013-01-15 10:28:35 +0000 So what I think I should actually do is make the encoder/decoder algorithms self-contained and inline the "global variables". In addition I need to design some kind of stream object concept and an operation that can inject units into that stream object (for the error conditions). Need to think about this some more. 92758 4 annevk 2013-08-30 18:28:56 +0000 A stream consists of unit sequence ended with EOF. A stream's next operation either returns the next unit, EOF, or PENDING if neither unit nor EOF available. TODO: Add a concept of "buffer" or a prepend operation. Need to think about output of encoder/decoder operation. Want to have either all units until PENDING (API), all units including EOF (sequence), or next unit (parsers). 92987 5 annevk 2013-09-04 16:21:59 +0000 Alternative plan for inlining the variables. We do something like: The utf-8 decoder is utf-8's encoder. The utf-8 encoder is utf8's decoder. The utf-8 decoder and utf-8 encoder have an associated utf-8 code point, utf-8 bytes seen, ... The utf-8 decoder's inner loop is: <current algorithm> So basically we turn it into a clearer class system and then we can also define in a more clear way how the inner loop is invoked and when variables associated with the encoder/decoder are reset. Combined with the abstract stream concept above does that make sense? 92988 6 jsbell 2013-09-04 16:26:59 +0000 SGTM 102937 7 annevk 2014-03-26 18:35:33 +0000 https://github.com/whatwg/encoding/commit/dc8e4c10c9b4a91f188f3145c2e31ddec4d52a78 This is a massive change. Review appreciated. 102944 8 jsbell 2014-03-26 19:33:02 +0000 The new TextEncoder/TextDecoder "serialized stream" algorithms appear to be unreferenced. They need to be integrated into the encode()/decode() method descriptions. (Also, there's a harmless typo in the source nearby: </codE>) 102945 9 jsbell 2014-03-26 19:34:03 +0000 (In reply to Joshua Bell from comment #8) > The new TextEncoder/TextDecoder "serialized stream" algorithms appear to be ^^ "serialize stream" > unreferenced. They need to be integrated into the encode()/decode() method > descriptions. > > (Also, there's a harmless typo in the source nearby: </codE>) ^^ Not harmless, mucks up the formatting on the TextEncoder's description. 102997 10 annevk 2014-03-27 12:25:49 +0000 I fixed the typo. The algorithm is cross-referenced. If you go to http://encoding.spec.whatwg.org/#concept-td-serialize and click the bold term you will find where it is referenced from. I do not always reuse the exact term as it does not always make sense in context. 103028 11 jsbell 2014-03-27 16:49:43 +0000 (In reply to Anne from comment #10) > I fixed the typo. The algorithm is cross-referenced. If you go to > http://encoding.spec.whatwg.org/#concept-td-serialize and click the bold > term you will find where it is referenced from. I do not always reuse the > exact term as it does not always make sense in context. Got it. That looks good to me. I haven't noticed any other glitches apart from the BOM handling ones mentioned in the other bug. Nice job on the refactor!