content [nfc]: s/image/image preview/, making room for new "inline image"

The API doc is being updated to distinguish the current "image
preview" content node from a new one, "image element presented in
Markdown syntax", which I think we'll just call "inline image". See
PR in progress: zulip/zulip#36226

Related: #1913

Author: chrisbobbe

lib/model/content.dart

@@ -524,19 +524,19 @@ class MathBlockNode extends MathNode implements BlockContentNode {
   });
 }
 
-class ImageNodeList extends BlockContentNode {
-  const ImageNodeList(this.images, {super.debugHtmlNode});
+class ImagePreviewNodeList extends BlockContentNode {
+  const ImagePreviewNodeList(this.imagePreviews, {super.debugHtmlNode});
 
-  final List<ImageNode> images;
+  final List<ImagePreviewNode> imagePreviews;
 
   @override
   List<DiagnosticsNode> debugDescribeChildren() {
-    return images.map((node) => node.toDiagnosticsNode()).toList();
+    return imagePreviews.map((node) => node.toDiagnosticsNode()).toList();
   }
 }
 
-class ImageNode extends BlockContentNode {
-  const ImageNode({
+class ImagePreviewNode extends BlockContentNode {
+  const ImagePreviewNode({
     super.debugHtmlNode,
     required this.srcUrl,
     required this.thumbnailUrl,
@@ -574,7 +574,7 @@ class ImageNode extends BlockContentNode {
 
   @override
   bool operator ==(Object other) {
-    return other is ImageNode
+    return other is ImagePreviewNode
       && other.srcUrl == srcUrl
       && other.thumbnailUrl == thumbnailUrl
       && other.loading == loading
@@ -583,7 +583,7 @@ class ImageNode extends BlockContentNode {
   }
 
   @override
-  int get hashCode => Object.hash('ImageNode',
+  int get hashCode => Object.hash('ImagePreviewNode',
     srcUrl, thumbnailUrl, loading, originalWidth, originalHeight);
 
   @override
@@ -1368,7 +1368,7 @@ class _ZulipContentParser {
 
   static final _imageDimensionsRegExp = RegExp(r'^(\d+)x(\d+)$');
 
-  BlockContentNode parseImageNode(dom.Element divElement) {
+  BlockContentNode parseImagePreviewNode(dom.Element divElement) {
     final elements = () {
       assert(divElement.localName == 'div'
           && divElement.className == 'message_inline_image');
@@ -1397,7 +1397,7 @@ class _ZulipContentParser {
       return UnimplementedBlockContentNode(htmlNode: divElement);
     }
     if (imgElement.className == 'image-loading-placeholder') {
-      return ImageNode(
+      return ImagePreviewNode(
         srcUrl: href,
         thumbnailUrl: null,
         loading: true,
@@ -1450,7 +1450,7 @@ class _ZulipContentParser {
       }
     }
 
-    return ImageNode(
+    return ImagePreviewNode(
       srcUrl: srcUrl,
       thumbnailUrl: thumbnailUrl,
       loading: false,
@@ -1875,7 +1875,7 @@ class _ZulipContentParser {
     }
 
     if (localName == 'div' && className == 'message_inline_image') {
-      return parseImageNode(element);
+      return parseImagePreviewNode(element);
     }
 
     if (localName == 'div') {
@@ -1928,10 +1928,10 @@ class _ZulipContentParser {
   List<BlockContentNode> parseImplicitParagraphBlockContentList(dom.NodeList nodes) {
     final List<BlockContentNode> result = [];
 
-    List<ImageNode> imageNodes = [];
-    void consumeImageNodes() {
-      result.add(ImageNodeList(imageNodes));
-      imageNodes = [];
+    List<ImagePreviewNode> imagePreviewNodes = [];
+    void consumeImagePreviewNodes() {
+      result.add(ImagePreviewNodeList(imagePreviewNodes));
+      imagePreviewNodes = [];
     }
 
     final List<dom.Node> currentParagraph = [];
@@ -1953,14 +1953,14 @@ class _ZulipContentParser {
       if (node case dom.Element(localName: 'p', className: '', nodes: [
             dom.Element(localName: 'span', className: 'katex-display'), ...])) {
         if (currentParagraph.isNotEmpty) consumeParagraph();
-        if (imageNodes.isNotEmpty) consumeImageNodes();
+        if (imagePreviewNodes.isNotEmpty) consumeImagePreviewNodes();
         parseMathBlocks(node.nodes, result);
         continue;
       }
 
       if (_isPossibleInlineNode(node)) {
-        if (imageNodes.isNotEmpty) {
-          consumeImageNodes();
+        if (imagePreviewNodes.isNotEmpty) {
+          consumeImagePreviewNodes();
           // In a context where paragraphs are implicit it should be impossible
           // to have more paragraph content after image previews.
           result.add(UnimplementedBlockContentNode(htmlNode: node));
@@ -1971,15 +1971,15 @@ class _ZulipContentParser {
       }
       if (currentParagraph.isNotEmpty) consumeParagraph();
       final block = parseBlockContent(node);
-      if (block is ImageNode) {
-        imageNodes.add(block);
+      if (block is ImagePreviewNode) {
+        imagePreviewNodes.add(block);
         continue;
       }
-      if (imageNodes.isNotEmpty) consumeImageNodes();
+      if (imagePreviewNodes.isNotEmpty) consumeImagePreviewNodes();
       result.add(block);
     }
     if (currentParagraph.isNotEmpty) consumeParagraph();
-    if (imageNodes.isNotEmpty) consumeImageNodes();
+    if (imagePreviewNodes.isNotEmpty) consumeImagePreviewNodes();
     return result;
   }
 
@@ -1988,10 +1988,10 @@ class _ZulipContentParser {
   List<BlockContentNode> parseBlockContentList(dom.NodeList nodes) {
     final List<BlockContentNode> result = [];
 
-    List<ImageNode> imageNodes = [];
-    void consumeImageNodes() {
-      result.add(ImageNodeList(imageNodes));
-      imageNodes = [];
+    List<ImagePreviewNode> imagePreviewNodes = [];
+    void consumeImagePreviewNodes() {
+      result.add(ImagePreviewNodeList(imagePreviewNodes));
+      imagePreviewNodes = [];
     }
 
     for (final node in nodes) {
@@ -2006,20 +2006,20 @@ class _ZulipContentParser {
       // handle it explicitly here.
       if (node case dom.Element(localName: 'p', className: '', nodes: [
             dom.Element(localName: 'span', className: 'katex-display'), ...])) {
-        if (imageNodes.isNotEmpty) consumeImageNodes();
+        if (imagePreviewNodes.isNotEmpty) consumeImagePreviewNodes();
         parseMathBlocks(node.nodes, result);
         continue;
       }
 
       final block = parseBlockContent(node);
-      if (block is ImageNode) {
-        imageNodes.add(block);
+      if (block is ImagePreviewNode) {
+        imagePreviewNodes.add(block);
         continue;
       }
-      if (imageNodes.isNotEmpty) consumeImageNodes();
+      if (imagePreviewNodes.isNotEmpty) consumeImagePreviewNodes();
       result.add(block);
     }
-    if (imageNodes.isNotEmpty) consumeImageNodes();
+    if (imagePreviewNodes.isNotEmpty) consumeImagePreviewNodes();
     return result;
   }
 

lib/widgets/content.dart

@@ -348,13 +348,13 @@ class BlockContentList extends StatelessWidget {
           SpoilerNode() => Spoiler(node: node),
           CodeBlockNode() => CodeBlock(node: node),
           MathBlockNode() => MathBlock(node: node),
-          ImageNodeList() => MessageImageList(node: node),
-          ImageNode() => (){
+          ImagePreviewNodeList() => MessageImagePreviewList(node: node),
+          ImagePreviewNode() => (){
             assert(false,
-              "[ImageNode] not allowed in [BlockContentList]. "
-              "It should be wrapped in [ImageNodeList]."
+              "[ImagePreviewNode] not allowed in [BlockContentList]. "
+              "It should be wrapped in [ImagePreviewNodeList]."
             );
-            return MessageImage(node: node);
+            return MessageImagePreview(node: node);
           }(),
           InlineVideoNode() => MessageInlineVideo(node: node),
           EmbedVideoNode() => MessageEmbedVideo(node: node),
@@ -614,22 +614,22 @@ class _SpoilerState extends State<Spoiler> with TickerProviderStateMixin {
   }
 }
 
-class MessageImageList extends StatelessWidget {
-  const MessageImageList({super.key, required this.node});
+class MessageImagePreviewList extends StatelessWidget {
+  const MessageImagePreviewList({super.key, required this.node});
 
-  final ImageNodeList node;
+  final ImagePreviewNodeList node;
 
   @override
   Widget build(BuildContext context) {
     return Wrap(
-      children: node.images.map((imageNode) => MessageImage(node: imageNode)).toList());
+      children: node.imagePreviews.map((node) => MessageImagePreview(node: node)).toList());
   }
 }
 
-class MessageImage extends StatelessWidget {
-  const MessageImage({super.key, required this.node});
+class MessageImagePreview extends StatelessWidget {
+  const MessageImagePreview({super.key, required this.node});
 
-  final ImageNode node;
+  final ImagePreviewNode node;
 
   @override
   Widget build(BuildContext context) {

lib/widgets/lightbox.dart

@@ -32,7 +32,7 @@ class _LightboxHeroTag {
     required this.src,
   });
 
-  /// The [BuildContext] for the [MessageImage] being expanded into the lightbox.
+  /// The [BuildContext] for the [MessageImagePreview] being expanded into the lightbox.
   ///
   /// In particular this prevents hero animations between
   /// different message lists that happen to have the same message.
@@ -45,7 +45,7 @@ class _LightboxHeroTag {
   ///
   /// This ensures the animation only occurs between matching images, even if
   /// the message was edited before navigating back to the message list
-  /// so that the original [MessageImage] has been replaced in the tree
+  /// so that the original [MessageImagePreview] has been replaced in the tree
   /// by a different image.
   final Uri src;